Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Builds a doc site from jade templates
JavaScript
Branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
tasks
test
.DS_Store
.gitignore
.jshintrc
Gruntfile.js
LICENSE-MIT
README.md
package.json

README.md

grunt-docsitebuilder

This plugin was created to build a Twitter Bootstrap like documentation site as part of the build process. The plugin will take all jade files in a folder and generate a doc site from these. It can be used together with the copy task to generate a full site with css, images, javascripts etc.

Getting Started

This plugin requires Grunt ~0.4.0

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

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

grunt.loadNpmTasks('grunt-docsitebuilder');

The "docsitebuilder" task

Overview

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

grunt.initConfig({
  docsitebuilder: {
    options: {
      siteRoot: 'src/styleguide/',
      fileExtension: 'html'
    },
    files: {
      'dist/docs/': [
        'src/styleguide/**/*.html.*'
      ]
    }
  }
})

Options

options.siteRoot

Type: String Default value: ''

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.*'
    ]
  }
}

options.fileExtension

Type: String Default value: '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 myfile.html

Something went wrong with that request. Please try again.