API
The public API of typedoc-plugin-markdown exposes some classes and types that can be used to customize the output of the plugin. Please note this only covers the API relevant to this plugin and not cover the entire TypeDoc API.
The APIs are typically consumed by writing local plugins.
Application
The Application class is the main entry point for a TypeDoc application and provides the mechanism to listen to hooks, events and define new themes.
| Member | Description |
|---|---|
| MarkdownApplication | An extended typing of TypeDoc’s Application instance. |
| MarkdownRenderer | An extended typing of TypeDoc’s Renderer class. |
| MarkdownPageEvent | An event emitted by before and after the markup of a page is rendered. |
| MarkdownRendererEvent | An event emitted at the beginning and end of the rendering process. |
| MarkdownRendererHooks | Describes the hooks available to inject output in the markdown theme. |
Theme
Classes and types that are used to define the Markdown theme and create custom themes.
| Member | Description |
|---|---|
| MarkdownTheme | The main theme class for the plugin. |
| MarkdownThemeContext | The theme context class that is provided as context on the rendering of every page. |
| PackageMetaData | The model used to define the package metadata when in packages mode. |
| UrlMapping | The model used to define the URL mapping structure. |
| NavigationItem | The model used to define the navigation structure. |
Options
Types that are used to define the plugin options.
| Member | Description |
|---|---|
| PluginOptions | Describes the options declared by the plugin. |
| TextContentMappings | Describes the keys available to replace static text. |