typedoc-github-wiki-theme

An extension of the default theme from typedoc-plugin-markdown to create a compatible file structure for Github Wiki pages.

Usage no npm install needed!

<script type="module">
  import typedocGithubWikiTheme from 'https://cdn.skypack.dev/typedoc-github-wiki-theme';
</script>

README

typedoc-github-wiki-theme

A Github Wiki compatible TypeDoc theme.

npm CI

What is does?

  • 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 --theme github-wiki [args]

Options

Please refer to typedoc-plugin-markdown.

License

MIT