grunt-init-basic
v0.1.0
Published
grunt-init template for a very basic project. includes nodeunit tests, jshint, watch, clean, and assemble for converting readme to a simple gh-pages index page.
Downloads
8
Readme
grunt-init-basic
grunt-init template for a very basic project. includes nodeunit tests, jshint, watch, clean, and assemble for converting readme to a simple gh-pages index page.
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-basic.git ~/.grunt-init/basic
(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/basic
, 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 basic
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.
Related info
- assemble-bootstrap: build Bootstrap's docs with Assemble (node.js) instead of Jekyll.
- generator-assemble: scaffolding generator for Assemble projects.
- grunt-init-assemble: generate new Handlebars helpers for Assemble.
- grunt-init-helper: generate new Handlebars helpers for Assemble.
- Assemble
Author
Copyright and license
Copyright 2013 Jon Schlinkert