tauri-apps/archived-typedoc-plugin-markdown
1
0
Fork 0
mirror of https://github.com/tauri-apps/typedoc-plugin-markdown.git synced 2026-01-31 00:45:20 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
next
archived-typedoc-plugin-mar…/packages/typedoc-github-wiki-theme/README.md
James 199c9f2878 fix: grammar
2022-05-25 16:09:09 -04:00

1.1 KiB
Raw Permalink Blame History

typedoc-github-wiki-theme

A Github 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-github-wiki-theme --save-dev

Usage

$ npx typedoc --theme github-wiki [args]

Options

Please refer to typedoc-plugin-markdown.

License

MIT