grunt-init-jekyll

Initialize new Jekyll projects.

npm install grunt-init-jekyll
19 downloads in the last month

grunt-init-jekyll

Visit http://jekyllrb.com. Jekyll is a simple, blog aware, static site generator. Quickly launch Jekyll projects in grunt-init.

Jekyll Documentation →

Disclaimer:

Please note that this is a very rough version, lacking many features you would expect. Please feel free to fork and put in a pull request if you see anything glaringly obvious that needs changing, as I am still very new to this.

Getting started

Installation

If you haven't already done so, install Grunt and grunt-init:

npm i -g grunt-cli grunt-init

Once grunt-init is installed, place this template in your ~/.grunt-init/ directory. It's recommended that you use git clone to install this template into that directory as follows:

git clone https://github.com/desjardinsm/grunt-init-jekyll.git ~/.grunt-init/jekyll

(Windows users, see the documentation for the correct destination directory path)

To force grunt-init to use custom default values, create a defaults.json file in your ~/.grunt-init/ directory, and customize the values in that file.

Note: you can make the template available as any name you choose by simply changing the name of the folder that the template is installed into. So instead of ~/.grunt-init/jekyll, you may change the name to ~/.grunt-init/foo so that the template can be used with the following command: grunt-init foo.

Usage

Now that grunt init is intalled, at the command-line, cd into an empty directory and run grunt-init jekyll and follow the prompts. You might want to test that it works before you begin customizing the project:

  • Next, run npm install and bower install to install the project's dependencies.
    • Then, run grunt to build the project and test that it works.

Note that this template will generate files in the current directory, so be sure to change to a new directory first.

Changelog

  • 2013-08-16 v0.1.0 Initial commit/fork

Todo

  • Change Gruntfile and other hardcoded values to use templates values

About

Forked from Jon Schlinkert's grunt-init-assemble, since I didn't find a jekyll-based grunt-init template. It's very much a work in progress at the moment. Feel free to PR anything you feel this needs.

Author

Matthew Desjardins

Copyright 2013 Matthew Desjardins

MIT License

npm loves you