Options
—remarkPlugins
💡
An array of remark plugin names.
Accepts an Array.
You can provide any compatible remark plugins or you can write your own and reference locally.
Each required plugin should be individually installed.
Options can be passed either as an array of strings or an array of string / options.
Please note that remark-frontmatter
, remark-gfm
, and remark-mdx
are always included by default.
typedoc.json
{
"remarkPlugins": [
"unified-prettier",
"remark-github",
[
"remark-toc",
{
"maxDepth": 3
}
]
]
}
—remarkStringifyOptions
💡
Custom options for the remark-stringify plugin.
Accepts a key/value object.
Under the hood, the remark-stringify
plugin is used to serialize the markdown into final output.
You can pass in options to the remark-stringify
plugin using this option.
Please see https://github.com/remarkjs/remark/tree/main/packages/remark-stringify#options
typedoc.json
{
"remarkStringifyOptions": {
"bullet": "+",
"fence": "~"
}
}