Skip to content

sclausen/typedoc-markdown-theme

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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.

About

Markdown theme for TypeDoc

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • HTML 36.6%
  • TypeScript 33.5%
  • JavaScript 29.9%