typedoc-gitlab-wiki-theme
A typedoc-plugin-markdown theme that publishes Markdown pages compatible with Gitlab Wiki.
![CI](https://github.com/tgreyuk/typedoc-plugin-markdown/actions/workflows/ci.yml/badge.svg?branch=master)
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-gitlab-wiki-theme@next --save-dev
Usage
typedoc.json
{
"plugin": ["typedoc-plugin-markdown", "typedoc-gitlab-wiki-theme"]
}
Options
For options please refer to typedoc-plugin-markdown.
The following options are preset with the theme:
{
"entryFileName": "home.md",
"flattenOutputFiles": true,
"hideBreadcrumbs": true,
"hideInPageTOC": true,
"hidePageHeader": true,
"hidePageTitle": true
}
License
MIT