https://github.com/tmcw-up-for-adoption/doxme

A Markdown formatter for dox. Takes dox's JSON output as stdin and writes Markdown to stdout.
https://github.com/tmcw-up-for-adoption/doxme

Last synced: 5 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/tmcw-up-for-adoption/doxme
• Owner: tmcw-up-for-adoption
• License: isc
• Archived: true
• Created: 2015-01-16T21:47:46.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2017-01-16T16:14:05.000Z (almost 8 years ago)
• Last Synced: 2024-10-22T22:43:26.284Z (17 days ago)
• Language: JavaScript
• Homepage:
• Size: 29.3 KB
• Stars: 13
• Watchers: 2
• Forks: 14
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - tmcw-up-for-adoption/doxme - A Markdown formatter for dox. Takes dox's JSON output as stdin and writes Markdown to stdout. (others)

README

        
**future work on documentation is going to be [in the documentation project instead of on doxme](https://github.com/documentationjs/documentation): documentation will have a higher level of configurability and compleness than doxme.**

# doxme

[![build status](https://secure.travis-ci.org/tmcw/doxme.png)](http://travis-ci.org/tmcw/doxme)

create markdown docs for dox output

### `doxme(dox, readme, package, travis)`

A [Markdown](http://daringfireball.net/projects/markdown/) formatter

for [dox](https://github.com/tj/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](https://travis-ci.org/) 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](https://travis-ci.org/) badge if the project is tested

with travis.

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

## See Also

* [gulp-doxme](https://github.com/tomekwi/gulp-doxme) runs doxme within a

  [Gulp](http://gulpjs.com/) pipeline

### Parameters

| parameter | type    | description                                      |

| --------- | ------- | ------------------------------------------------ |

| `dox`     | Object  | the output of dox as a parsed JSON object        |

| `readme`  | boolean | whether to output a readme or just docs          |

| `package` | Object  | a parsed package.json                            |

| `travis`  | boolean | whether to output a travis badge along with docs |

### Example

```js

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](http://nodejs.org/).

```sh

$ npm install doxme

```

## Tests

```sh

$ npm test

```