https://github.com/jsdoc2md/grunt-jsdoc-to-markdown

Markdown API documentation generator
https://github.com/jsdoc2md/grunt-jsdoc-to-markdown

Last synced: about 1 year ago
JSON representation

Markdown API documentation generator

• Host: GitHub
• URL: https://github.com/jsdoc2md/grunt-jsdoc-to-markdown
• Owner: jsdoc2md
• License: mit
• Created: 2014-06-26T15:41:17.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2021-02-26T23:11:52.000Z (over 5 years ago)
• Last Synced: 2024-04-24T12:26:47.473Z (about 2 years ago)
• Language: JavaScript
• Homepage:
• Size: 147 KB
• Stars: 17
• Watchers: 2
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
[![view on npm](https://badgen.net/npm/v/grunt-jsdoc-to-markdown)](https://www.npmjs.org/package/grunt-jsdoc-to-markdown)

[![npm module downloads](https://badgen.net/npm/dt/grunt-jsdoc-to-markdown)](https://www.npmjs.org/package/grunt-jsdoc-to-markdown)

[![Gihub repo dependents](https://badgen.net/github/dependents-repo/jsdoc2md/grunt-jsdoc-to-markdown)](https://github.com/jsdoc2md/grunt-jsdoc-to-markdown/network/dependents?dependent_type=REPOSITORY)

[![Gihub package dependents](https://badgen.net/github/dependents-pkg/jsdoc2md/grunt-jsdoc-to-markdown)](https://github.com/jsdoc2md/grunt-jsdoc-to-markdown/network/dependents?dependent_type=PACKAGE)

[![Build Status](https://travis-ci.org/jsdoc2md/grunt-jsdoc-to-markdown.svg?branch=master)](https://travis-ci.org/jsdoc2md/grunt-jsdoc-to-markdown)

[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](https://github.com/feross/standard)

# grunt-jsdoc-to-markdown

A grunt plugin for [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown). Accepts the same options as the [`render` method](https://github.com/jsdoc2md/jsdoc-to-markdown/blob/master/docs/API.md#jsdoc2mdrenderoptions--promise).

## Install

```sh

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

```

## Usage

Example `Gruntfile.js`:

```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](https://github.com/test-runner-js/test-runner).