Skip to content
This repository was archived by the owner on May 7, 2021. It is now read-only.

codeactual/apidox

Folders and files

NameName
Last commit message
Last commit date
May 8, 2013
May 2, 2014
Aug 29, 2013
Jan 12, 2018
Jan 12, 2018
Jan 9, 2018
Apr 24, 2013
Apr 14, 2019
Jul 16, 2020
Jan 9, 2018
Apr 24, 2013
Sep 30, 2013
May 2, 2014
May 8, 2013
Apr 1, 2021
Jul 16, 2020

Repository files navigation

apidox

Generate node.js API markdown with dox

Build Status

Markdown

Main differences from dox --api:

  • Method references are auto-linked to associated sections
  • Links to Table of Contents and parent object's section
  • <ul> of @param w/ two levels of sub-items
  • <ul> of @throws w/ one level of sub-items
  • @return with one level of <ul> items
  • <ul> of @see (w/ dox URL detection intact)
  • Boldfaced section headings (ex. Configuration:) in method summaries
  • Source file link

Examples

CLI

cd /path/to/proj
apidox --input lib/util/index.js --output docs/Util.md

Output

Installation

npm install apidox

API

Documentation

License

MIT

Contributors

Tests

npm test