❤
npm
Sign UpSign In

typedoc-github-wiki-theme
TypeScript icon, indicating that this package has built-in type declarations

1.1.0 • Public • Published

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

Options

Please refer to typedoc-plugin-markdown.

License

MIT

Dependencies (0)

    Dev Dependencies (1)

    Package Sidebar

    Install

    npm i typedoc-github-wiki-theme

    Repository

    github.com/tgreyuk/typedoc-plugin-markdown

    Homepage

    github.com/tgreyuk/typedoc-plugin-markdown/tree/master/packages/typedoc-github-wiki-theme

    Weekly Downloads

    7,319

    Version

    1.1.0

    License

    MIT

    Unpacked Size

    8.37 kB

    Total Files

    9

    Last publish

    Collaborators

    • tgreyuk
    Try on RunKit
    Report malware