# pug-doc-markdown

> Pug (Jade) documentation output markdown

Latest version **1.0.1** (published 2016-01-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install pug-doc-markdown
pnpm add pug-doc-markdown
yarn add pug-doc-markdown
bun add pug-doc-markdown
```

Provides the command `pug-doc-markdown`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2016-01-13 |
| First published | 2016-01-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 9 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Arjen Scherff-de Water |
| Maintainers | aratramba |
| Keywords | jade, jade-doc, pug, pug-doc, documentation, markdown |

## Links

- npm: https://www.npmjs.com/package/pug-doc-markdown
- Repository: https://github.com/Aratramba/pug-doc-markdown
- Homepage: https://github.com/Aratramba/pug-doc-markdown#readme
- Issues: https://github.com/Aratramba/pug-doc-markdown/issues
- npm.io page: https://npm.io/package/pug-doc-markdown

## Dependencies (9)

- [meow](https://npm.io/package/meow.md) ^3.4.1
- [tape](https://npm.io/package/tape.md) ^4.2.1
- [faucet](https://npm.io/package/faucet.md) 0.0.1
- [mkdirp](https://npm.io/package/mkdirp.md) ^0.5.1
- [pretty](https://npm.io/package/pretty.md) ^1.0.0
- [traverse](https://npm.io/package/traverse.md) ^0.6.6
- [JSONStream](https://npm.io/package/JSONStream.md) ^1.0.6
- [object-assign](https://npm.io/package/object-assign.md) ^4.0.1
- [is-empty-object](https://npm.io/package/is-empty-object.md) ^1.1.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.0.1 (latest) — 2016-01-13
- 1.0.0 — 2016-01-13
- 0.11.0 — 2016-01-13

## README

# Pug-doc Markdown

Generates Markdown output from a [Pug-doc](http://github.com/Aratramba/pug-doc/) stream or input pug-doc json.


### Command Line
```bash
pug-doc-markdown --input pug-doc.json --output output.md
```

```bash
pug-doc input.jade | pug-doc-markdown --output output.md
```


### Node
```js
var stream = new PugDocMarkdown({
    output: 'output.html',
    input: 'data.json'
});

stream.on('complete', function(){
  console.log('complete');
});
```

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