handlebars-helper

grunt-readme handlebars helper, for doing foo, bar and baz.

In the root of your project, run the following in the command line:

npm i helper-grunt-readme --save-dev

{{grunt-readme "path/to/file.grunt-readme"}}

In your Gruntfile, simply add helper-grunt-readme to the helpers property in the Assemble task or target options:

grunt.initConfig({
  assemble: {
    options: {
      helpers: ['helper-grunt-readme']
    }
    ...
  }
});

With that completed, you may now being using the grunt-readme helper in your Assemble project.

Options can be set in your Gruntfile, in the grunt-readme object in the Assemble task or target options:

grunt.initConfig({
  assemble: {
    options: {
      readme: {
        foo: true
      }
    }
    ...
  }
});

Here are some related projects you might be interested in from the Assemble core team.

grunt-convert

Grunt task to convert to or from JSON, YAML, XML, PLIST or CSV.

grunt-firebase

Grunt task for updating firebase data.

grunt-github-api

Grunt plugin used to query the Github API and save the returned JSON files locally.

grunt-matter

Add, extend, sort, and strip YAML front matter. Also has options for populating randomized mock data.

grunt-repos

Use Grunt to pull down a list of repos from GitHub.

grunt-toc

Grunt plugin for generating a markdown Table of Contents (TOC).

Visit assemble.io/plugins for more information about Assemble plugins.

Jon Schlinkert

Brian Woodward

This file was generated by grunt-readme on Saturday, December 14, 2013.

Last updated 4 years ago