Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
JavaScript documentation generator for node using markdown and jsdoc
JavaScript

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
bin
lib
.gitmodules
History.md
Makefile
Readme.md
docs.html

Readme.md

Dox

Dox is a JavaScript documentation generator written for node.

Dox is a 2 hour product of my frustration with documentation generators. I wanted something that could parse my JavaScript using markdown and JSDoc tags, an easy to use executable, as well as a single deployment file, no external css or js, one file!

Features

  • Supports JSDoc
  • Markdown bodies
  • Custom title / description
  • Simple CLI dox
  • Single file generated
  • Generated navigation menu
  • Linked function definitions with references
  • Syntax highlighting
  • Fast (can process 36 large files in 200ms)

Installation

$ make install

Usage Examples

Simple example:

$ dox --title Connect lib/connect/index.js

Lots of files:

$ dox --title Connect --desc "markdown _here_" $(file lib/* -type f) > docs.html

Usage

Output from --help:

Usage: dox [options] <file ...>

Options:
  -t, --title      Project title
  -d, --desc       Project description (markdown)
  -s, --style      Document style, available: ["default"]
  -J, --no-jsdoc   Disable jsdoc parsing (coverts to markdown)
  -p, --private    Output private code in documentation
  -h, --help       Display help information
Something went wrong with that request. Please try again.