Package Exports
- grunt-docs
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (grunt-docs) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
grunt-docs
A grunt plugin to compile using DocPad.
ATTENTION: This plugin has changed completely on v0.5. It is now a thin wrapper for DocPad generate and not a multitask.
Getting Started
Install this grunt plugin next to your project's
[Gruntfile.js gruntfile][http://gruntjs.com/getting-started] with:
npm install grunt-docs
Then add this line to your project's Grunfile.js gruntfile:
grunt.loadNpmTasks('grunt-docs');Documentation
This plugin provides the task: docs. You can pass in your
DocPad configuration directly:
docs: {
srcPath: 'src/',
outPath: 'build/',
}Please view the example for an example folder structure for converting file types.
Contributing
Please use the issue tracker and pull requests.
Release History
- 0.5.1 Update docpad to latest.
- 0.5.0 Now just a wrapper for docpad generate.
- 0.4.0 Support for Grunt v0.4. Update docpad version.
- 0.3.1 Ability to set DocPad config with
options. - 0.3.0 Update to DocPad 6.6.6. Refactor for migration to Grunt 0.4.
- 0.2.0 Convert to use DocPad
- 0.1.1 More testable structure of module
- 0.1.0 Initial release
License
Copyright (c) 2013 Kyle Robinson Young
Licensed under the MIT license.