API
API Index

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

DocumentDescription
Local PluginsHow to write local plugins to consume APIs.
Customizing OutputHow to extend and customize output.
Utilizing NavigationHow to create a custom navigation structure.

Events

ClassDescription
MarkdownPageEventAn event emitted before and after the markdown of a page is rendered.
MarkdownRendererEventAn event emitted at the beginning and end of the rendering process.

Theme Classes

ClassDescription
MarkdownThemeThe main theme class for the plugin.
MarkdownThemeContextThe theme context class that is provided as context on the rendering of every page.

Interfaces

InterfaceDescription
MarkdownApplicationThe MarkdownApplication extends TypeDoc’s Application instance with a custom renderer.
MarkdownRendererHooksDescribes the hooks available to inject output in the markdown theme.
MarkdownRendererThe MarkdownRenderer extends TypeDoc’s Renderer instance with custom hooks and async jobs.
PluginOptionsDescribes the options declared by the plugin.
UrlMappingThe model used to define the URL mapping structure.
NavigationItemThe model used to define the navigation structure.