typedoc-plugin-markdown

A plugin for TypeDoc that renders TypeScript API documentation as Sphinx.


What it does?

The plugin replaces the default HTML theme with a built-in Sphinx theme and exposes some additional options.

Useful if documentation is required to be included in project README files, Wikis and static site generators.

Installation

``bash
npm install --save-dev typedoc typedoc-plugin-markdown
`

Usage

Usage is the same as documented at TypeDoc.

`bash
typedoc --plugin typedoc-plugin-markdown --out docs src/index.ts
`

> The plugin switches the default html theme to the in-built markdown theme as default. If using with the default html theme, use --plugin none to switch the plugin off.

Options

The following options can be used in addition to relevant TypeDoc options
(please note that TypeDoc options specific to the html theme will be ignored).

- --entryDocument

The file name of the entry document. Defaults to README.md.
- --hideBreadcrumbs

Do not render breadcrumbs in template header. Defaults to false.
- --hideInPageTOC

Do not render in-page table of contents items. Defaults to false.
- --hideMembersSymbol

Do not add special symbols for class members. Defaults to false.
- --publicPath

Specify the base path for all urls. If undefined urls will be relative. Defaults to ..
- --namedAnchors

Use HTML named anchors tags for implementations that do not assign header ids. Defaults to false.
- --preserveAnchorCasing

Preserve anchor id casing for implementations where original case is desirable. Defaults to false`.

License

MIT