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
History
tgreyuk e86bda396e chore: Switched to changesets and npm workspaces
2022-12-11 21:11:26 +00:00
..
src
chore: Switched to changesets and npm workspaces
2022-12-11 21:11:26 +00:00
CHANGELOG.md
chore: Switched to changesets and npm workspaces
2022-12-11 21:11:26 +00:00
jest.config.js
Updated Jest
2022-06-28 23:10:52 +01:00
LICENSE
Added githubwiki theme
2020-10-12 22:26:33 +01:00
package.json
Updated Jest
2022-06-28 23:10:52 +01:00
README.md
fix: grammar
2022-05-25 16:09:09 -04:00
tsconfig.json
Added githubwiki theme
2020-10-12 22:26:33 +01:00
tsconfig.test.json
Added githubwiki theme
2020-10-12 22:26:33 +01:00

README.md

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