Skip to content
This repository has been archived by the owner. It is now read-only.
Quickly build gh-pages documentation from a project README using Grunt.js and Assemble, a Node.js alternative to Jekyll.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib
root
.gitignore
LICENSE-MIT
README.md
package.json
rename.json
template.js

README.md

grunt-init-ghpages

Quickly build gh-pages documentation from a project README using Grunt.js and Assemble, a Node.js alternative to Jekyll.

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/assemble/grunt-init-ghpages.git ~/.grunt-init/ghpages

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

To force grunt-init to use custom default values, move the defaults.json file to 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/ghpages, 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 assemble and follow the prompts. You might want to test that it works before you begin customizing the project:

  • Next, run npm 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.

What this project contains

In the the test directory you will find the following files:

  • example.hbs: this is an example template, which contains code for both an example helper and a starting point for your new custom helper.
  • example.json: this is the data file used by the helper
  • helper-example.js: umm...

Related info

Author

Jon Schlinkert

Copyright and license

Copyright 2013 Jon Schlinkert

MIT License

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.