grunt-makdoc

grunt task for makdoc.

npm install grunt-makdoc
4 downloads in the last week
8 downloads in the last month

grunt-makdoc

A Grunt plugin for makdoc

Getting Started

Install the module with: npm install grunt-makdoc --save-dev

Then add this line to your project's Gruntfile.js gruntfile:

grunt.loadNpmTasks('grunt-makdoc');

Configure your document projects:

grunt.initConfig({
  // ...
  makdoc : {
    docs : { // This can be changed what you want
      /* optional */
      src: 'src/docs/',
      out: 'out/docs/',
      documents: {
        cwd: 'documents/',
        files: '**/*.*'
      },
      layouts: {
        cwd: 'layouts/',
        files: '**/*.*'
      },
      partials: {
        cwd: 'partials/',
        files: '**/*.*'
      }
    }
  }
  // ...
});
  • src: This indecate source directory of documents.
  • out: This is target directory that result after makdoc rendering.
  • documents.cwd: Document directory.
  • documents.files: Document file pattern.
  • layouts.cwd: Layout directory.
  • layouts.files: Layout file pattern.
  • partials.cwd: Partial directory.
  • partials.files: Partial file pattern.

Default directory layout is following. put your documents:

.
└── src
  └── docs
    ├── documents
    ├── layouts
    └── partials

Run this task with grunt makdoc command.

Read Makdoc Document for more information.

License

Copyright (c) 2013+ Makdoc Licensed under the MIT license.

npm loves you