GJekyllBuilder

Jekyll project builder. Internally, it creates child process to run jekyll command.
To learn more about Jekyll, visit Jekyll website.

Builder specific Options

• conf.src (type:string, default:undefined)
  
  If this is set to a directory path, it will be used to override default jekyll source directory.

• conf.dest (type:string, default:undefined)
  
  If this is set to a directory path, it will be used to override default jekyll desitination directory.

Notes

• conf.flushStream (type:boolean, default:false)
  
  If this is set to true, build task will not finish until external jekyll command finishes.

• Important: If you have any dependencies in jekyll project, such as scss or scripts, then be sure to add flushStream option to them so that all the output files are ready before jekyll compiler starts. See here for an example
  

Example

const jkDest = '../_gh_pages';

const jekyll = {
    buildName: 'jekyll',
    builder: 'GJekyllBuilder',
    src: '.',
    dest: jkDest,
    moduleOptions: {
        jekyll: {
            command: 'build',
            options: [
                '--incremental',
                '--baseurl /gulp-build-manager/_gh_pages'
            ]
        }
    },
    watch: ['**/*', '!.jekyll-metadata', '!assets/**/*', '!gulpfile.*'],
    clean: [jkDest, '.jekyll-metadata'],
};

Resources

• This document site was built with GJekyllBuilder and CCSSBuilder.
• See docs build configuration for more details.