# Markdown theme for TypeDoc

[TypeDoc](http://typedoc.io/) is a documentation generator for TypeScript projects.
This module enebles you to obtain a markdown version of the TypeDoc output.

## Usage

```bash
$ npm install typedoc typedoc-markdown-theme --save-dev
$ node_modules/.bin/typedoc --theme node_modules/typedoc-markdown-theme/bin --out doc path/to/ts/dir
```

See TypeDoc documentation (http://typedoc.io/) to learn more about TypeDoc.

## What does it look like?

You can see an example output at [examples dir](https://github.com/kimamula/typedoc-markdown-theme/tree/master/examples).