Utils & Themes
Github Wiki

typedoc-github-wiki-theme

Version: 2.0.0

Overview

This plugin generates Markdown tailored to GitHub Wiki.

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→
Useful PluginsQuick Start