README.md

apidox

Generate node.js API markdown with dox

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

• weir
• conjure

Installation

NPM

npm install apidox

API

Documentation

License

MIT

Contributors

• @davedoesdev

Tests

npm test