Beautiful documentation generator from Markdown files for Grunt
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-bulldoc --save-devOnce the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt.loadNpmTasks('grunt-bulldoc');In your project's Gruntfile, add a section named bulldoc to the data object passed into grunt.initConfig().
grunt.initConfig({
bulldoc: {
options: {
// Task-specific options go here.
},
your_target: {
// Target-specific file lists and/or options go here.
},
},
})Type: String
Default value: 'template/'
Name of the template directory in your documentation folder. You probably don't want to change this.
Type: String
Default value: template.html
Name of the HTML template, where parsed Markdown is injected. This file should be in options.templateDir folder. You probably don't want to change this either.
First, you will need a template which will be used to generate the documentation.
There is one already available in templates/flatdoc, or in node_modules/grunt-bulldoc/templates/flatdoc.
Copy files from this folder somewhere, for example into docs/source/.
Now you can edit this template however you want.
To generate the documentation, add this task into your Gruntfile:
grunt.loadNpmTasks('grunt-bulldoc');
grunt.initConfig({
bulldoc: {
example: {
files: { 'docs/result/': 'docs/source/' }
}
}
})Your docs/source/ folder can look like this:
template/
template.html
assets/
...
first-doc.md
second-doc.md
Then your docs/results/ folder will look like this:
assets/
...
first-doc.html
second-doc.html
Sure.
See LICENSE-MIT.
(MIT, obviously.)
Original Flatdoc theme by Rico Sta. Cruz and contributors. Released under the MIT License.