# Documentation

[Also see examples →](./EXAMPLES.md)

**Table of Contents**
{%= toc %}

## Overview
In general, the conventions used by this task are as follows:

**Templates**
* Files with extension `.tmpl.md` are generally templates that will be compiled one-to-one into documents
* Files with extension `.md` are generally intended to be used as includes.
* `[%= _.doc("foo") %]` is used to included files from your project's `./docs` directory
* `[%= _.include("foo") %]` is used to include boilerplate files from grunt-readme

## Advanced configuration
To change the plugin's defaults, add a section to your project's Gruntfile named `{%= shortname %}` to the data object passed into `grunt.initConfig()`:

```js
grunt.initConfig({
  // The "repos" task
  repos: {
    options: {}
  },

  // The "readme" task
  readme: {
    options: {
      metadata: {}
    }
  }
});
grunt.loadNpmTasks('grunt-readme');
grunt.registerTask('default', ['readme']);
```
## The "repos" task
{%= _.doc("repos-task.md") %}

## Features
{%= _.doc("docs-features.md") %}

## Options
{%= _.doc("docs-options.md") %}

## Mixins
{%= _.doc("docs-mixins.md") %}

## Author

+ [github.com/{%= username %}](https://github.com/{%= username %})
+ [twitter.com/{%= username %}](http://twitter.com/{%= username %})

## License
{%= copyright %}
{%= license %}

***

_This file was generated on {%= grunt.template.date("fullDate") %}._


[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