Generate node.js module API markdown with dox
JavaScript
Clone or download
Latest commit 39f82e0 Jan 13, 2018
Permalink
Failed to load latest commit information.
bin fix(npm): Remove circular dependencies May 8, 2013
dist chore(npm): Upgrade deps May 2, 2014
docs feat(throws): Init support Aug 29, 2013
lib Make @return formatting consistent with @param and @throw Jan 12, 2018
test Add nested lists to @return in test Jan 12, 2018
.eslintrc.js Remove node-component-grunt dep Jan 9, 2018
.gitignore
.travis.yml
CHANGELOG.md chore(npm): Upgrade deps May 2, 2014
Gruntfile.js
LICENSE chore(repo): Init Apr 24, 2013
README.md feat(markdown): Support two levels of list items under @param Sep 30, 2013
component.json chore(npm): Upgrade deps May 2, 2014
index.js chore(package): Rename to apidox May 8, 2013
package-lock.json Make @return formatting consistent with @param and @throw Jan 12, 2018
package.json Make @return formatting consistent with @param and @throw Jan 12, 2018

README.md

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

npm install apidox

API

Documentation

License

MIT

Contributors

Tests

npm test