1.1.1 • Published 8 months ago

@carlosingles/typedoc-gitlab-wiki-theme v1.1.1

Weekly downloads
-
License
MIT
Repository
github
Last release
8 months ago

typedoc-gitlab-wiki-theme

A Gitlab Wiki compatible TypeDoc theme.

npm CI

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.

License

MIT