Customizing Frontmatter
For advanced use a local plugin can be written to listen for the emitted event MarkdownPageEvent.BEGIN (before the page has been written) and then update the frontmatter config. See MarkdownPageEvent.
typedoc.json
{
"plugin": [
"typedoc-plugin-markdown",
"typedoc-plugin-frontmatter",
"./custom-frontmatter.mjs"
]
}custom-frontmatter.mjs
// @ts-check
import { ReflectionKind } from 'typedoc';
import { MarkdownPageEvent } from 'typedoc-plugin-markdown';
/**
* @param {import('typedoc-plugin-markdown').MarkdownApplication} app
*/
export function load(app) {
app.renderer.on(
MarkdownPageEvent.BEGIN,
/** @param {import('typedoc-plugin-markdown').MarkdownPageEvent} page */
(page) => {
/**
* Update page.frontmatter object using information from the page model
*
* Here if the page is a class, we set the title to the class name
*/
if (page.model?.kind == ReflectionKind.Class) {
page.frontmatter = {
// e.g add a title
title: page.model?.name,
// spread the existing frontmatter
...page.frontmatter,
};
}
},
);
}