JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 52177
  • Score
    100M100P100Q175444F
  • License MIT

An extension of the default theme from typedoc-plugin-markdown to create a compatible file structure for Github Wiki pages.

Package Exports

  • typedoc-github-wiki-theme
  • typedoc-github-wiki-theme/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (typedoc-github-wiki-theme) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

typedoc-github-wiki-theme

A Github Wiki compatible TypeDoc theme.

npm CI

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 --theme github-wiki [args]

Options

Please refer to typedoc-plugin-markdown.

License

MIT