typedoc-github-wiki-theme

typedoc-github-wiki-theme

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.

Installation

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

Features

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

Documentation

See the documentation for installation, configuration options, and usage guides.

License

MIT