Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

JavaScript documentation generator for node using markdown and jsdoc

branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 bin
Octocat-spinner-32 lib
Octocat-spinner-32 .gitignore
Octocat-spinner-32 History.md
Octocat-spinner-32 Makefile
Octocat-spinner-32 Readme.md
Octocat-spinner-32 index.html
Octocat-spinner-32 package.json
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

Installation

Install from npm:

$ npm install dox

Install from git clone or tarball:

$ 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)
-i, --intro      File that contains introduction text (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.