doxdox-renderer-markdown/README.md

Markdown renderer for doxdox.

# doxdox-renderer-markdown

> Markdown renderer for doxdox.

[![NPM version](https://img.shields.io/npm/v/doxdox-renderer-markdown?style=flat-square)](https://www.npmjs.org/package/doxdox-renderer-markdown)
[![NPM downloads per month](https://img.shields.io/npm/dm/doxdox-renderer-markdown?style=flat-square)](https://www.npmjs.org/package/doxdox-renderer-markdown)
[![doxdox documentation](https://img.shields.io/badge/doxdox-documentation-%23E85E95?style=flat-square)](https://doxdox.org)

## Install

```bash
$ npm install doxdox-cli@v4.0.0-preview.24 doxdox-renderer-markdown@v4.0.0-preview.24 --save-dev
```

## Usage

```bash
$ doxdox -r markdown > docs.md
```

or

```bash
$ doxdox -r markdown -o docs.md
```