Package Exports

typedoc-github-wiki-theme
typedoc-github-wiki-theme/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (typedoc-github-wiki-theme) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

typedoc-github-wiki-theme

A typedoc-plugin-markdown theme that publishes Markdown pages compatible with Github Wiki.

What does it do?

This theme customises the output from typedoc-plugin-markdown:

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@next typedoc-github-wiki-theme@next --save-dev

Usage

typedoc.json

{
  "plugin": ["typedoc-plugin-markdown", "typedoc-github-wiki-theme"]
}

Options

For options please refer to typedoc-plugin-markdown.

The following options are preset with the theme:

{
  "entryFileName": "Home.md",
  "flattenOutputFiles": true,
  "skipIndexPage": true,
  "hideInPageTOC": true,
  "hidePageHeader": true,
  "hideBreadcrumbs": true,
  "hidePageTitle": true
}

License

MIT