olivernn / dox-template

simple templates for dox

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Dox Template

A simple template for use with the dox documentation library.

Installation

npm install dox-template

Usage

dox < my_awesome_lib.js | dox-template -r 0.0.1 > my_awesome_lib_docs.html

For more usage run dox-template -h.

Examples

This is currently in use for Davis.js api documentation and for splunk docs.

About

simple templates for dox


Languages

Language:JavaScript 100.0%