grunt-init-assemble

Initialize new Assemble projects.

grunt-init-assemble

Quickly launch Assemble-based projects using grunt-init, including starter templates and data.

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

(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/assemble, you may change the name to ~/.grunt-init/foo so that the template can be used with the following command: grunt-init foo.

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.

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...