grunt-init-assemble

grunt-init-assemble

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

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

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

Related projects

• handlebars-helpers
• Assemble's documentation
• assemble-less

Assemble generators

• generator-assemble: Yeoman generator for Assemble, the static site generator built on Grunt.js. Kickstart new Assemble projects in just a few seconds, including templates, data, layouts, and a theme.
• grunt-init-assemble: Grunt init template for Assemble, the static site generator built on Grunt.js. Kickstart new Assemble projects in just a few seconds, including templates, data, layouts, and a theme.
• grunt-init-assemble-plugin: Generate a plugin for Assemble.
• 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.
• grunt-init-ghpages: Quickly build gh-pages documentation from a project README using Grunt.js and Assemble, a Node.js alternative to Jekyll.
• grunt-init-helper: Grunt init template for creating Assemble helpers.

Assemble plugins

Some plugins from the Assemble core team that you might be interested in using in your projects:

• assemble-contrib-anchors: Assemble plugin for creating anchor tags from generated html.
• assemble-contrib-contextual: Generates a JSON file containing the context of each page. Basic plugin to help see what's happening in the build.
• assemble-contrib-decompress: Assemble plugin for extracting zip, tar and tar.gz archives.
• assemble-contrib-download: Assemble plugin for downloading files from GitHub.
• assemble-contrib-lunr: Assemble plugin for creating a search engine within your static site using lunr.js.
• assemble-contrib-markdown: Convert markdown files to HTML using marked.js. This plugin is an alternative to Assemble's markdown Handlebars helpers. Both are useful in different scenarios.
• assemble-contrib-permalinks: Permalinks plugin for Assemble, the static site generator for Grunt.js and Yeoman. This plugin enables powerful and configurable URI replacement patterns, presets, uses Moment.js for parsing dates, and much more.
• assemble-contrib-sitemap: Sitemap generator plugin for Assemble
• assemble-contrib-toc: Create a table of contents in the generated HTML, using Cheerio.js
• assemble-contrib-wordcount: Assemble plugin for displaying a word-count on blog posts or pages. Visit assemble.io/plugins for more information about Assemble plugins.

Assemble boilerplates

• boilerplate-bootstrap: Build Bootstrap with Assemble instead of Jekyll.
• boilerplate-gist-blog: Use Assemble to create a blog from GitHub Gists.
• boilerplate-h5bp: Assemble + HTML5 Boilerplate.
• boilerplate-markdown: Use Assemble to generate HTML pages from markdown content. Useful for wikis, gh-pages, documentation and blogs or sites with markdown posts.
• boilerplate-site: Demonstrates how to use Assemble to build a site. Includes layouts, pages, partials, and markdown content.
• boilerplate-sitemap: Generate a sitemap with Assemble.
• boilerplate-swig: Example of using swig templates with Assemble.

Authors

Jon Schlinkert

• http://twitter.com/jonschlinkert
• http://github.com/jonschlinkert

Brian Woodward

• http://twitter.com/doowb
• http://github.com/doowb

Copyright and license

Copyright 2013 Jon Schlinkert

MIT License