Name		Name	Last commit message	Last commit date
parent directory ..
src		src
.gitignore		.gitignore
CHANGELOG.md		CHANGELOG.md
LICENSE		LICENSE
README.md		README.md
jest.config.js		jest.config.js
package.json		package.json
tsconfig.json		tsconfig.json
tsconfig.test.json		tsconfig.test.json

README.md

typedoc-github-wiki-theme

A Github Wiki compatible TypeDoc theme.

What Does It Do?

Generates Wiki friendly file names.
Updates internal urls to a compatible format.
Writes a _Sidebar.md file to enable custom sidebar navigation.

Installation

npm install typedoc typedoc-plugin-markdown typedoc-github-wiki-theme --save-dev

Usage

$ npx typedoc --plugin typedoc-plugin-markdown --plugin typedoc-github-wiki-theme [args]

Options

Please refer to typedoc-plugin-markdown.

License