Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Generate node.js module API markdown with dox
JavaScript
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
bin
dist
docs
lib
test
.gitignore
.travis.yml
CHANGELOG.md
Gruntfile.js
LICENSE
README.md
component.json
index.js
package.json

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
Something went wrong with that request. Please try again.