Documentation generator from Markdown and HTML template
Beautiful documentation generator from Markdown files for Grunt
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-bulldoc --save-dev
In your project's Gruntfile, add a section named
bulldoc to the data object passed into
gruntinitConfigbulldoc:options:// Task-specific options go here.your_target:// Target-specific file lists and/or options go here.
Name of the template directory in your documentation folder. You probably don't want to change this.
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
Copy files from this folder
Now you can edit this template however you want.
To generate the documentation, add this task into your Gruntfile:
gruntloadNpmTasks'grunt-bulldoc';gruntinitConfigbulldoc:example:files: 'docs/result/': 'docs/source/'
docs/source/ folder can look like this:
docs/results/ folder will look like this: