Create a server for your documentation using Flatdoc
npm install grunt-flatdoc> Create a server for your documentation using Flatdoc
~0.4.2If 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:
``shell`
npm install grunt-flatdoc --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
`js`
grunt.loadNpmTasks('grunt-flatdoc');
to the data object passed into grunt.initConfig().`js
grunt.initConfig({
flatdoc: {
your_target: {
// Target-specific file lists and/or options go here.
},
},
});
`$3
#### options.file
Type:
String/Boolean
Default value: falseA markdown file to create the server
#### options.folder
Type:
String
Default value: '.'A folder to concatenate all the markdown files contained and create the server
$3
#### Default Options
In this example shows how grunt-flatdoc can be used to open an entire folder with .md files
`js
grunt.initConfig({
flatdoc: {
dist: {
folder: 'doc'
}
},
});
``