Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content
This repository has been archived by the owner on Sep 1, 2024. It is now read-only.

Markdown API documentation generator

License

Notifications You must be signed in to change notification settings

jsdoc2md/grunt-jsdoc-to-markdown

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

67 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

view on npm npm module downloads Gihub repo dependents Gihub package dependents Build Status js-standard-style

grunt-jsdoc-to-markdown

A grunt plugin for jsdoc-to-markdown. Accepts the same options as the render method.

Install

$ npm install grunt-jsdoc-to-markdown --save-dev

Usage

Example Gruntfile.js:

'use strict'
module.exports = function (grunt) {
  grunt.initConfig({
    jsdoc2md: {
      oneOutputFile: {
        src: 'src/*.js',
        dest: 'api/documentation.md'
      },
      separateOutputFilePerInput: {
        files: [
          { src: 'src/jacket.js', dest: 'api/jacket.md' },
          { src: 'src/shirt.js', dest: 'api/shirt.md' }
        ]
      },
      withOptions: {
        options: {
          'no-gfm': true
        },
        src: 'src/wardrobe.js',
        dest: 'api/with-index.md'
      }
    }
  })

  grunt.loadNpmTasks('grunt-jsdoc-to-markdown')
  grunt.registerTask('default', 'jsdoc2md')
}

© 2014-21 Lloyd Brookes <75pound@gmail.com>.

Tested by test-runner.