@carlosingles/typedoc-gitlab-wiki-theme
v1.1.1
Published
An extension of the default theme from typedoc-plugin-markdown to create a compatible file structure for GitLab Wiki pages.
Downloads
4
Maintainers
Readme
typedoc-gitlab-wiki-theme
A Gitlab Wiki compatible TypeDoc theme.
What Does It Do?
- 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-gitlab-wiki-theme --save-dev
Usage
$ npx typedoc --plugin typedoc-plugin-markdown --plugin typedoc-gitlab-wiki-theme [args]
Options
Please refer to typedoc-plugin-markdown.