grunt-jekyll
Advanced tools
A custom grunt.js plugin that executes jekyll compile and/or watch for you
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: boolean
LiveReload refreshes your browser after a change.
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']);
raw optiongrunt.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()
}
}
}
});
--pygments option flag. Bugfixes.MIT
FAQs
A custom grunt.js plugin that executes jekyll compile and/or watch for you
The npm package grunt-jekyll receives a total of 760 weekly downloads. As such, grunt-jekyll popularity was classified as not popular.
We found that grunt-jekyll demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.
Security News
NVD’s backlog surpasses 20,000 CVEs as analysis slows and NIST announces new system updates to address ongoing delays.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.