grunt-literate

grunt-literate

Generate docs from your source

Getting Started

This plugin requires Grunt ~0.4.1

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins.

Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-literate --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-literate');

The "literate" task

In your project's Gruntfile, add a section named literate to the data object passed into grunt.initConfig().

grunt.initConfig({
  literate: {
     "README.md": "lib/foobar.js"
  }
});

The source will be parsed as JavaScript, and /** ... comments extracted to the destionation file. This example uses markdown, but you are free to use any format, or even just plain text.

Options

There are no options yet.

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt. Make a pull request, but don't commit README.md!

Release History

• 0.1.1 Fix issue with unindenting
• 0.1.0 Initial release

Related work

This task could be abused to do literate programming.