Plugin to create a doc site from Jade templates
This plugin requires Grunt
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-docsitebuilder --save-dev
In your project's Gruntfile, add a section named
docsitebuilder to the data object passed into
gruntinitConfigdocsitebuilder:options:siteRoot: 'src/styleguide/'fileExtension: 'html'files:'dist/docs/':'src/styleguide/**/*.html.*'
This value - if set - tells the plugin where the root of the destination doc site is. The destination doc site will be built from this root.
If a source file is in
src/styleguide/index.html.jade and it should be built in
dist/docs/index.html the setup would look like this:
options:siteRoot: 'src/styleguide/'fileExtension: 'html'files:'dist/docs/':'src/styleguide/**/*.html.*'
A string value that sets the required file extension for the compiled jade files. If the jade files have filenames like
myfile.html.jade the extension is not added, but if the jade file have filenames like
myfile.jade the extion will be added.
Both scenarios end with a file named