node package manager

grunt-jekyll

A custom grunt.js plugin that executes jekyll compile and/or watch for you

grunt-jekyll

Currently seeking someone to maintain this project.

Compile Jekyll sites with Grunt.

This plugin requires Grunt ~0.4.0 and Jekyll >= v1.0.0.

If you haven't used Grunt before, be sure to check out the Getting Started guide which explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process you may install this plugin with the command:

npm install grunt-jekyll --save-dev

After the plugin has been installed, load it in your Gruntfile with:

grunt.loadNpmTasks('grunt-jekyll');

Run this task with the grunt jekyll command.

This task helps you compile your Jekyll static site with Grunt.

Type: boolean
Default: false

Build the site and start a Jekyll development server on http://localhost:4000. The server lasts forever: kill it with Ctrl + C.

If serve is false, the site is built with the build command.

For complex projects you may want to use grunt-contrib-connect or grunt-browser-sync instead.

Type: boolean
Default: false

Test your site for common errors and deprecated code. Ignores all other options except src, config, and bundleExec.

You can use all of the configuration options available in the Jekyll Documentation, as well as some special options provided by this plugin.

Type: string
Default: .

Directory where Jekyll will read files.

Type: string
Default: ./_site

Directory where Jekyll will write files.

Type: boolean
Default: false

Regenerate the site when files are modified. If you are running multiple watch tasks in a project you should use grunt-contrib-watch instead.

Type: string
Default: _config.yml

Specify a custom configuration file. Multiple files separated by a comma will cascade right to left.

Type: string

Create a temporary _config.yml with the contents of raw. This config file has greater precedence than the files in config.

Type: boolean
Default: false

Disables custom plugins, and ignore symbolic links.

Type: string
Default: ./_plugins

Specify a plugins directory.

Type: string
Default: ./_layouts

Specify a layouts directory.

Type: boolean
Default: false

Process and render draft posts.

Type: boolean
Default: false

Publishes posts with a future date.

Type: boolean
Default: false

Produce an index for related posts.

Type: number

Limit the number of posts to parse and publish.

Type: boolean

Force watch to use polling.

Type: boolean

Print verbose output.

Type: boolean

Silence the normal output from Jekyll during a build.

Type: boolean

Enable the experimental incremental build feature. Incremental build only re-builds posts and pages that have changed, resulting in significant performance improvements for large sites, but may also break site generation in certain cases.

Type: string or number

Listen on the given port (requires serve).

Type: string

Listen at the given hostname (requires serve).

Type: string

Serve the website from the given base URL (requires serve).

Type: boolean

Skips the initial site build which occurs before the server is started.

Type: boolean

Opens the local URL in your default browser.

Type: boolean
Default: false

Run jekyll with bundle exec.

Follow this Grunt example to get started with grunt-jekyll right away.

grunt.initConfig({
  jekyll: {                             // Task 
    options: {                          // Universal options 
      bundleExec: true,
      src : '<%= app %>'
    },
    dist: {                             // Target 
      options: {                        // Target options 
        dest: '<%= dist %>',
        config: '_config.yml,_config.build.yml'
      }
    },
    serve: {                            // Another target 
      options: {
        serve: true,
        dest: '.jekyll',
        drafts: true,
        future: true
      }
    }
  }
});
 
grunt.loadNpmTasks('grunt-jekyll');
 
grunt.registerTask('default', ['jshint', 'jekyll']);
grunt.initConfig({
  jekyll: {
    dist: {
      options: {
        config: '_config.yml',
        // Construct a string with JavaScript. 
        // Remember, in YAML line breaks and indentation matter. 
        raw: 'pygments: false\n' +
             'exclude: [\'development\']\n' +
             'author:\n' +
             '  name: ' + fetchAuthor() + '\n' +
             '  email: ' + fetchEmail()
      }
    }
  }
});
  • v0.4.3: More options support for Jekyll 3.0.0
  • v0.4.2: More internal optimizations.
  • v0.4.1: Internal optimizations.
  • v0.4.0: Added setup for tests.
  • v0.3.9: Consolidating branches and bumping version number.
  • v0.3.8: Added @robwierzbowski's raw option and other PRs.
  • v0.3.6:
    • Reviewed Jekyll's source and updated plugin with new flags.
    • Reviewed and warned about deprecated flags.
    • Updated documentation to match flag updates. (Rewritten as a list)
  • v0.3.3: Updated link in documentation. Added to-do list.
  • v0.3.2: Added option to select config file. Removed deprecated --pygments option flag. Bugfixes.
  • v0.3.0: Update for Jekyll 1.0
  • v0.2.1: Fixed destination path option.
  • v0.2.0: Updated README with better options. Options are more flexible.
  • v0.1.6: Updated README with better example.
  • v0.1.0: Initial Release.

MIT