1.8.2 • Published 10 years ago

doxme v1.8.2

Weekly downloads
559
License
ISC
Repository
github
Last release
10 years ago

doxme

build status

create markdown docs for dox output

doxme(dox, readme, package, travis)

A Markdown formatter for dox. Takes dox's JSON output as stdin and writes Markdown to stdout.

  • Generates API documentation as well as entire READMEs (like this one!)
  • README generation supports Travis-CI badges

CLI Usage

dox -r < index.js | doxme

The doxme bin supports one important option: --readme. When provided, it generates a full README.md file, including title, description, installation and test instructions, and a Travis-CI badge if the project is tested with travis.

dox -r < index.js | doxme --readme > README.md

See Also

Parameters

parametertypedescription
doxObjectthe output of dox as a parsed JSON object
readmebooleanwhether to output a readme or just docs
packageObjecta parsed package.json
travisbooleanwhether to output a travis badge along with docs

Example

var fs = require('fs');
var dox = require('dox');
var doxme = require('doxme');

var sourceCode = fs.readFileSync('./index.js', 'utf8');
var documentation = doxme(dox.parseComments(sourceCode));

Returns String, documentation

Installation

Requires nodejs.

$ npm install doxme

Tests

$ npm test
1.8.2

10 years ago

1.8.1

10 years ago

1.8.0

10 years ago

1.7.1

10 years ago

1.7.0

10 years ago

1.6.0

10 years ago

1.5.2

10 years ago

1.5.0

10 years ago

1.4.3

10 years ago

1.4.2

10 years ago

1.4.1

10 years ago

1.4.0

10 years ago

1.3.0

10 years ago

1.2.2

10 years ago

1.2.1

10 years ago

1.2.0

10 years ago

1.1.0

10 years ago

1.0.0

10 years ago