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
f92eb86d6c231ae4e91ba52bb759693835824c87
archived-typedoc-plugin-mar…/packages/typedoc-github-wiki-theme
History
tgreyuk 83e588fd64 docs: Fixed typos
2021-05-11 21:44:07 +01:00
..
src
feat: Improved sidebar structure
2021-05-10 22:05:29 +01:00
test/specs
feat: Improved sidebar structure
2021-05-10 22:05:29 +01:00
CHANGELOG.md
docs: Fixed typos
2021-05-11 21:44:07 +01:00
jest.config.js
Added githubwiki theme
2020-10-12 22:26:33 +01:00
LICENSE
Added githubwiki theme
2020-10-12 22:26:33 +01:00
package.json
chore(release)
2021-05-11 21:37:58 +01:00
README.md
Readme updates
2021-04-21 22:57:52 +01: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 Build Status

What is does?

  • 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 --plugin typedoc-plugin-markdown --theme ./node_modules/typedoc-github-wiki-theme/dist [args]

License

MIT