laxar-dox.md

The "laxar_dox" task

Uses laxar_dox to output API documentation in markdown format.

Overview

Run this task with the grunt laxar_dox command.

Task targets, files and options may be specified according to the grunt Configuring tasks guide.

Options

None

Usage examples

One markdown file

grunt.initConfig( {
   laxar_dox: {
      lib: {
         files: {
            'docs/api.md': [ 'lib/**/*.js' ]
         }
      }
   }
} );

Multiple markdown files

grunt.initConfig( {
   laxar_dox: {
      lib: {
         files: {
            expand: true,
            cwd: 'lib',
            src: 'lib/**/*.js',
            dest: 'docs/api/',
            ext: '.md'
         }
      }
   }
} );