grunt-flatdoc

Create a server for your documentation using Flatdoc

Getting Started

This plugin requires Grunt ~0.4.2

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-flatdoc --save-dev

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

grunt.loadNpmTasks('grunt-flatdoc');

The "flatdoc" task

Overview

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

grunt.initConfig({
  flatdoc: {    
    your_target: {
      // Target-specific file lists and/or options go here.      
    },
  },
});

Options

options.file

Type: String/Boolean Default value: false

A 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

options.template

Type: String/Boolean Default value: false

Your Flatdoc template file

Usage Examples

Default Options

In this example shows how grunt-flatdoc can be used to open an entire folder with .md files

grunt.initConfig({
  flatdoc: {
    dist: {
      options:{
        folder: 'doc'
      }
    }    
  },
});

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release History

(Nothing yet)