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.
40 lines (26 loc) • 879 B
Markdown
# {%= name %} {%= _.badge("fury") %} {%= _.badge("travis") %}
> {%= description %}
## Getting Started
{%= _.doc("docs-getting-started.md") %}
## The "{%= shortname %}" task
### Overview
{%= _.doc("docs-overview.md") %}
### Options
{%= _.doc("docs-options.md") %}
### Usage Examples
{%= _.doc("docs-examples.md") %}
***
## Contributing
{%= _.contrib("contributing.md") %}
## Release History
{%= _.include("release-history.md") %}
## Other Grunt tasks
+ [assemble](http://assemble.io): Static site generator for Grunt.js, Yeoman and Node.js. Used by H5BP/Effeckt, Topcoat, Web Experience Toolkit, and hundreds of other projects to build sites, themes, components, documentation, blogs and gh-pages.
{%= _.include("related-repos-list.md") %}
## Authors
{%= _.contrib("contrib-authors.md") %}
## License
{%= copyright %}
{%= license %}
***
{%= _.include("footer.md") %}