/typedoc-markdown-theme

Markdown theme for TypeDoc

Primary LanguageHTMLMIT LicenseMIT

Markdown theme for TypeDoc

TypeDoc is a documentation generator for TypeScript projects. This module enebles you to obtain a markdown version of the TypeDoc output.

Usage

$ 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.