Yoctol/node-apidoc-markdown

Name: node-apidoc-markdown

Owner: YOCTOL INFO INC.

Description: Generate API documentation in markdown from apidoc data

Forked from: softdevstory/node-apidoc-markdown

Created: 2017-05-03 12:17:18.0

Updated: 2017-05-03 12:17:20.0

Pushed: 2017-05-10 06:38:56.0

Homepage: null

Size: 15

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

apidoc-markdown2

Generate API documentation in markdown from apidoc data.

Installation

npm install apidoc-markdown2

Usage

Usage: apidoc-markdown2 -p [path] -o [output file]

Options:
  --path, -p      Path to generated apidoc output. Where api_data.json & api_project.json resides.  [required]
  --output, -o    Output file to write.                                                             [required]
  --template, -t  Path to EJS template file, if not specified default template will be used.
  --prepend       Prepend file after TOC.

Examples

Generate from included example data

apidoc-markdown2 -p examples -o examples/example.md

View generated example

Why apidoc-markdown2

apidoc-markdown is not maintained for long time. New tags of apidoc are not supported. This version is applied pull request for supporting new tags.