grunt-jekyll

grunt-jekyll

Straightforward grunt.js Jekyll plugin. The code base is inspred by grunt-compass. This means its use is similar but outlined in detail here.

Dependencies

You need to have node.js, grunt.js, Ruby and Jekyll installed for this to work.

This task works only with Jekyll 1.0.x. Please use grunt-jekyll versions prior to 0.3.0 for Jekyll prior to the 1.0 release - simply specify this version in your package.json.

Quick Start

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

Installation & Options

Installation

Install this grunt plugin next to your project's grunt.js gruntfile with:

npm install grunt-jekyll

Configuration Options

All the configuration options are

• on the Jekyll Wiki.
• optional
• explained here within the grunt.js task object context:

Object Property	Type	Default Value	Notes
src	[path]	"."	Source Path
dest	[path]	"./site"	Destination Path
safe	[bool]	false	Disables custom plugins.
watch	[bool]	false	Jekyll watches src path for changes.
server	[bool]	false	Jekyll Server
server_port	[int]	undefined	Server Port
baseurl	[url]	undefined	Serve from URL
url	[url]	undefined	Sets site.url
markdown	[engine]	undefined	Markdown Engine
future	[bool]	false	Publish Future Posts
lsi	[bool]	false	Related Posts Index
permalink	[style]	undefined	Permalink Style
paginate	[int]	undefined	Per-page Pagination
limit_posts	[int]	undefined	Max Posts
config	[path]	undefined	Specify a config file. Overrides settings in `_config.yml`

To-do

• Review Jekyll source and update task with new flags.
• Review and remove deprecated flags.
• Update documentation to match flag updates. (Rewrite as a list)
• Provide in-line code examples to this readme.

Changelog

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 License

grunt-jekyll is freely distributable under the terms of the MIT license.

Copyright (c) 2012, Danny Garcia. All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.