node package manager

grunt-docs

grunt-docs

A grunt plugin to compile using DocPad.

Getting Started

Install this grunt plugin next to your project's Gruntfile.js gruntfile 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

  • 1.0.0 Update docpad and tag peer deps >=.
  • 0.8.0 Update docpad to latest v6.64.3. Docpad now installed as peerDep and set the correct Grunt working directory (@kasperisager).
  • 0.7.0 Update docpad to latest v6.63.3.
  • 0.6.0 Update docpad to latest v6.46.3.
  • 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) 2016 Kyle Robinson Young
Licensed under the MIT license.