@browsie/typedoc-plugin-carbodocs v0.0.3

typedoc-plugin-markdown

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

What it does?

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

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

Installation

npm install --save-dev typedoc typedoc-plugin-markdown@next

Usage

Usage is the same as documented at TypeDoc

typedoc --plugin typedoc-plugin-markdown

The --plugin arg is optional (all plugins are loaded by default unless set). 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).

File output options

See File output options for further documentation.

• --entryDocument The file name of the entry document. Defaults to README.md.
• --symbolsWithOwnFile Determines which symbols should be written to their own file. Expected values none, all OR Array of class, interface, enum, function, var, type Defaults to all (all symbols exported to an individual file).

UI options

• --hideBreadcrumbs Do not print breadcrumbs header. Defaults to false.
• --hideInPageTOC Do not print in-page index items. Defaults to false.
• --hidePageTitle Do not print the page title. Defaults to false.
• --hideHierarchy Do not print reflection hierarchy. Defaults to false.
• --enableLongTitles Display full name including module paths in page titles. Defaults to false.

Frontmatter options

See Front matter options for further documentation.

• --enableFrontmatter Prepend output with a YAML front matter block. Defaults to false.
• --frontmatterTags Specify which file comment tags should be added to front matter variables (as an array).
• --frontmatterGlobals Specify global static variables to be added to all front matter blocks (as an object).

Utility options

• --namedAnchors Use HTML named anchors tags for implementations that do not assign header ids. Defaults to false.
• --baseUrl Specifies the base url for internal link. If omitted all urls will be relative. Defaults to .

Documentation

• File output options
• Frontmatter options
• Readme files

License

MIT