A plugin for TypeDoc that exposes a theme and options for rendering markdown.
Branch: master
Clone or download
Latest commit 1b5fbe5 Feb 7, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
examples Updated fixtures Oct 27, 2018
src Start code blocks with new line Feb 6, 2019
test Start code blocks with new line Feb 6, 2019
.editorconfig Added .ts rules Apr 14, 2018
.gitignore Renamed tests directory Apr 17, 2018
.travis.yml TypeDoc 0.12.0 Aug 20, 2018
LICENSE Added license Jun 24, 2017
README.md Updated fixtures Dec 22, 2018
jest.config.js Replaced mocha/chai with Jest Oct 27, 2018
logos.png Updated readme Oct 27, 2018
package-lock.json 1.1.26 Feb 6, 2019
package.json 1.1.26 Feb 6, 2019
tsconfig.json Changed tsconfig target from es5 to es2015 Jan 5, 2019
tslint.json

README.md

typedoc-plugin-markdown

A plugin for TypeDoc that exposes a theme and additional arguments for rendering markdown.

npm Build Status

Installation

npm install --save-dev typedoc typedoc-plugin-markdown

Usage

The plugin provides an additional theme named 'markdown' that can be referenced by name:

shell

$ node_modules/.bin/typedoc --theme markdown

npm script

"scripts": {
 "docs": "typedoc --theme markdown"
}

Arguments

The plugin exposes the following arguments in addition to TypeDoc's defaults:

--mdEngine <github|bitbucket|gitbook>

The target markdown rendering engine:

Engine Description
github (default) Optimized for GitHub Flavored markdown.
bitbucket Renders markdown to support Bitbucket's internal anchor linking.
gitbook Generates additional SUMMARY.md file to enable a table of contents.

--mdHideSources

Suppress source file linking from output.

--mdSourceRepo <path.to.repo>(Ignored on GitHub repositories)

For projects hosted on GitHub TypeDoc resolves source files. This argument allows targeting of source files hosted on other environments.

For Bitbucket use: https://bitbucket.org/owner/repository_name.

What does it look like?

The markdown theme aims to provide the same functionality as the default theme with a simple breadcrumb navigation. To get an idea of the output view some generic example output.

Acknowledgements

Thanks to kimamula's typedoc-markdown-theme for the inspiration behind this project.