typedoc-github-wiki-theme

Version: 2.1.0

Overview

typedoc-github-wiki-theme applies GitHub Wiki-specific naming and link behavior on top of typedoc-plugin-markdown.

Use it when you want the generated API docs to drop straight into a repository wiki without manually reworking page names, links, or sidebar navigation.

Features

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

Example

The following is a simple example of a GithubWiki project running TypeDoc.

View Wiki on Github View Source on Github