API
The public API of typedoc-plugin-markdown exposes some classes and types that can be used to customize the output of the plugin. If you are interested more generally in the TypeDoc API please visit https://typedoc.org.
Documents
| Document | Description |
|---|---|
| Local Plugins | How to write local plugins to consume APIs. |
| Customizing Output | How to extend and customize output. |
| Utilizing Navigation | How to create a custom navigation structure. |
Events
| Class | Description |
|---|---|
| MarkdownPageEvent | An event emitted before and after the markdown of a page is rendered. |
| MarkdownRendererEvent | An event emitted at the beginning and end of the rendering process. |
Theme Classes
| Class | 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. |
Interfaces
| Interface | Description |
|---|---|
| MarkdownApplication | The MarkdownApplication extends TypeDoc’s Application instance with a custom renderer. |
| MarkdownRendererHooks | Describes the hooks available to inject output in the markdown theme. |
| MarkdownRenderer | The MarkdownRenderer extends TypeDoc’s Renderer instance with custom hooks and async jobs. |
| PluginOptions | Describes the options declared by the plugin. |
| UrlMapping | The model used to define the URL mapping structure. |
| NavigationItem | The model used to define the navigation structure. |