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.
56 lines (41 loc) • 1.55 kB
Markdown
---
username: jonschlinkert
org: assemble
---
> {%= description %}
[](./DOCS.md) | [Examples →](./EXAMPLES.md)
Please [report any bugs or feature requests](https://github.com/{%= org %}/{%= name %}/issues/new), thanks!
{%= _.doc("docs-quickstart.md") %}
{%= _.doc("docs-example.md") %}
Please see the [Contributing to {%= name %}]({%= homepage %}/blob/master/CONTRIBUTING.md) guide for information on contributing to this project.
{% if (changelog) {
_.each(changelog, function(details, version) {
var date = details.date;
if (date instanceof Date) {
date = grunt.template.date(new Date(date.getTime() + date.getTimezoneOffset() * 60000), 'yyyy-mm-dd');
}
print('\n * ' + [
date,
version,
details.changes.join(' '),
].join('\u2003\u2003\u2003'));
});
} else { %}
_(Nothing yet)_
{% } %}
+ [github.com/{%= username %}](https://github.com/{%= username %})
+ [twitter.com/{%= username %}](http://twitter.com/{%= username %})
{%= copyright %}
{%= license %}
***
_This file was generated by [grunt-readme](https://github.com/assemble/grunt-readme) on {%= grunt.template.date("fullDate") %}._
[]: http://gruntjs.com/
[]: https://github.com/gruntjs/grunt/blob/devel/docs/getting_started.md
[]: https://npmjs.org/doc/json.html