marked-toc
Version:
Generate a markdown TOC (table of contents).
102 lines (70 loc) • 3.37 kB
Markdown
# {{grunt-readme}} [](http://badge.fury.io/js/helper-grunt-readme)
> grunt-readme handlebars helper, for doing foo, bar and baz.
<!-- toc -->
## Quickstart
In the root of your project, run the following in the command line:
```bash
npm i helper-grunt-readme --save-dev
```
## Usage
```handlebars
{{grunt-readme "path/to/file.grunt-readme"}}
```
## Usage in Assemble
In your Gruntfile, simply add `helper-grunt-readme` to the `helpers` property in the [Assemble](http://assemble.io) task or target options:
```javascript
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
### task options
Options can be set in your Gruntfile, in the `grunt-readme` object in the Assemble task or target options:
```javascript
grunt.initConfig({
assemble: {
options: {
readme: {
foo: true
}
}
...
}
});
```
## Related projects
Here are some related projects you might be interested in from the [Assemble](http://assemble.io) core team.
#### [grunt-convert](https://github.com/assemble/grunt-convert) [](http://badge.fury.io/js/grunt-convert)
> Grunt task to convert to or from JSON, YAML, XML, PLIST or CSV.
#### [grunt-firebase](https://github.com/assemble/grunt-firebase) [](http://badge.fury.io/js/grunt-firebase)
> Grunt task for updating firebase data.
#### [grunt-github-api](https://github.com/assemble/grunt-github-api) [](http://badge.fury.io/js/grunt-github-api)
> Grunt plugin used to query the Github API and save the returned JSON files locally.
#### [grunt-matter](https://github.com/assemble/grunt-matter) [](http://badge.fury.io/js/grunt-matter)
> Add, extend, sort, and strip YAML front matter. Also has options for populating randomized mock data.
#### [grunt-repos](https://github.com/assemble/grunt-repos) [](http://badge.fury.io/js/grunt-repos)
> Use Grunt to pull down a list of repos from GitHub.
#### [grunt-toc](https://github.com/assemble/grunt-toc) [](http://badge.fury.io/js/grunt-toc)
> Grunt plugin for generating a markdown Table of Contents (TOC).
Visit [assemble.io/plugins](http:/assemble.io/plugins/) for more information about [Assemble](http:/assemble.io/) plugins.
## Author
**Jon Schlinkert**
+ [github/jonschlinkert](https://github.com/jonschlinkert)
+ [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
**Brian Woodward**
+ [github/doowb](https://github.com/doowb)
+ [twitter/doowb](http://twitter.com/jonschlinkert)
## License
Copyright (c) 2013 Jon Schlinkert, contributors.
Released under the MIT license
***
_This file was generated by [grunt-readme](https://github.com/assemble/grunt-readme) on Saturday, December 14, 2013._
[grunt]: http://gruntjs.com/
[Getting Started]: https://github.com/gruntjs/grunt/blob/devel/docs/getting_started.md
[package.json]: https://npmjs.org/doc/json.html