grunt-readme
Version:
Grunt plugin for generating a README from templates, including an optional table of contents. No Gruntfile config is necessary, just choose a starter template and you'll be ready to go.
42 lines (26 loc) • 1.54 kB
Markdown
# {%= name %} [](http://badge.fury.io/js/{%= name %}) {% if (travis) { %} []({%= travis %}){% } %}
> {%= description %}
# Quickstart
{%= _.doc("quickstart.md") %}
# Examples
{%= _.doc("examples.md") %}
## Related Projects
You might also be interested in these other plugins from the Assemble core team: {% _.each(repos, function(plugin) { %}{% if(/\bcontrib\b/g.test(plugin.name) && plugin.name.indexOf(shortname) === -1) { %}
### [{%= plugin.name %}]({%= plugin.url %}) [](http://badge.fury.io/js/{%= plugin.name %})
> {%= plugin.description %} {% } %} {% }); %}
To update this list, download this project, then in the command line run `npm i && node docs/repos && grunt`.
## Contributing
Find a bug? Have a feature request? Please [create an Issue](https://github.com/assemble/assemble/issues/new). Pull requests are also encouraged.
If you find this project useful, please consider "starring" it to show your support! Thanks!
## Authors
**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 %}
{%= license %}
***
_This file was generated by [grunt-readme](https://github.com/assemble/grunt-readme) on {%= grunt.template.date("fullDate") %}._