Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

53 lines (40 sloc) 0.935 kb

The "laxar_dox" task

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'
         }
      }
   }
} );
Jump to Line
Something went wrong with that request. Please try again.