Miss any of our Open RFC calls?Watch the recordings here! »

apidoc-to-markdown

1.0.2 • Public • Published

apidoc-markdown

Generate API documentation in markdown from apidoc data.

WARNING

This is a porting for internal use and should not be used in production, due to the ejs security bug

Installation

npm install apidoc-to-markdown

Usage

Usage: apidoc-markdown -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-to-markdown -p examples -o examples/example.md

View generated example

Install

npm i apidoc-to-markdown

DownloadsWeekly Downloads

2

Version

1.0.2

License

MIT

Unpacked Size

22.6 kB

Total Files

8

Last publish

Collaborators

  • avatar