MarkdownTheme
The main theme class for the plugin.
The class controls how TypeDoc models are mapped to files and templates and extends TypeDoc’s base Theme class.
You would typically only be interested in overriding the the theme’s render context instance.
The API follows the implementation of TypeDoc’s custom theming with some minor adjustments.
Extends
Constructors
new MarkdownTheme()
new MarkdownTheme(
renderer
):MarkdownTheme
Parameters
Parameter | Type |
---|---|
renderer | Renderer |
Returns
Overrides
Theme.constructor
Methods
getRenderContext()
getRenderContext(
page
):MarkdownThemeContext
Creates a new instance of the current theme context.
This method can be overridden to provide an alternative theme context.
Parameters
Parameter | Type |
---|---|
page | MarkdownPageEvent <Reflection > |
Returns
getUrls()
getUrls(
project
):UrlMapping
<Reflection
>[]
Maps the models of the given project to the desired output files.
Parameters
Parameter | Type |
---|---|
project | ProjectReflection |
Returns
Overrides
Theme.getUrls
getNavigation()
getNavigation(
project
):NavigationItem
[]
Map the models of the given project to a navigation structure.
Parameters
Parameter | Type |
---|---|
project | ProjectReflection |