# doxme

> create markdown docs for dox output

Latest version **1.8.2** (published 2015-03-02) · ISC license · 0 weekly downloads

## Install

```sh
npm install doxme
pnpm add doxme
yarn add doxme
bun add doxme
```

Provides the command `doxme`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.8.2 |
| Published | 2015-03-02 |
| First published | 2015-01-16 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 13 |
| Author | Tom MacWright |
| Maintainers | tmcw |
| Keywords | dox, jsdoc, markdown, documentation |

## Links

- npm: https://www.npmjs.com/package/doxme
- Repository: git@github.com:tmcw/doxme
- Homepage: https://github.com/tmcw/doxme
- Issues: https://github.com/tmcw/doxme/issues
- npm.io page: https://npm.io/package/doxme

## Dependencies (5)

- [minimist](https://npm.io/package/minimist.md) ^1.1.0
- [striptags](https://npm.io/package/striptags.md) ^2.0.0
- [concat-stream](https://npm.io/package/concat-stream.md) ^1.4.7
- [markdown-table](https://npm.io/package/markdown-table.md) ^0.3.1
- [repo-path-parse](https://npm.io/package/repo-path-parse.md) ^1.0.1

## Alternatives

- [@cantoo/pdf-lib](https://npm.io/package/@cantoo/pdf-lib.md) — 297.9K weekly downloads
- [datatables.net-buttons](https://npm.io/package/datatables.net-buttons.md) — 200.1K weekly downloads
- [@ckeditor/ckeditor5-export-pdf](https://npm.io/package/@ckeditor/ckeditor5-export-pdf.md) — 167.0K weekly downloads
- [scanbot-web-sdk](https://npm.io/package/scanbot-web-sdk.md) — 15.0K weekly downloads
- [@syncfusion/ej2-angular-pdfviewer](https://npm.io/package/@syncfusion/ej2-angular-pdfviewer.md) — 8.8K weekly downloads

## Recent versions

- 1.8.2 (latest) — 2015-03-02
- 1.8.1 — 2015-02-24
- 1.8.0 — 2015-02-24
- 1.7.1 — 2015-02-24
- 1.7.0 — 2015-02-23
- 1.6.0 — 2015-02-22
- 1.5.2 — 2015-02-22
- 1.5.0 — 2015-02-13
- 1.4.3 — 2015-02-03
- 1.4.2 — 2015-01-22
- 1.4.1 — 2015-01-22
- 1.4.0 — 2015-01-22
- 1.3.0 — 2015-01-21
- 1.2.2 — 2015-01-21
- 1.2.1 — 2015-01-20
- … 3 more at https://npm.io/package/doxme/versions

## README

# 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
```

---
_Source: https://npm.io/package/doxme · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._