Options
—frontmatterGlobals
Specify static variables to be added to all frontmatter blocks.
Accepts a key/value object.
---
layout: docs
sidebar: true
---
{
"frontmatterGlobals": {
"layout": "docs",
"sidebar": true
}
}
—readmeFrontmatter
Specify static variables to be added to the readme page only.
Accepts a key/value object.
{
"readmeFrontmatter": {
"onReadme": "true"
}
}
—indexFrontmatter
Specify static variables to be added to the index page only.
Accepts a key/value object.
{
"indexFrontmatter": {
"onIndex": "true"
}
}
—frontmatterCommentTags
Specify which comment block tags should be added to frontmatter.
Accepts an Array.
Frontmatter variables can be added by extracting comments from block (@) tags.
Please note tags must be added to the comment blocks of the symbol exported to a page.
/**
* @author Joe Bloggs
*
* @description A description that will be added to frontmatter.
*/
---
author: Joe Bloggs
description: A description that will be added to frontmatter.
---
In addition any non standard tags should be added to a tsdoc.json
file and added next to your tsconfig.json
file.
{
"$schema": "https://developer.microsoft.com/en-us/json-schemas/tsdoc/v0/tsdoc.schema.json",
"extends": ["typedoc/tsdoc.json"],
"tagDefinitions": [
{
"tagName": "@customTag",
"syntaxKind": "modifier"
}
]
}
{
"frontmatterCommentTags": ["author", "description"]
}
—preserveFrontmatterCommentTags
Preserve tags defined in frontmatter block tags in output.
Accepts a boolean value. Defaults to
false
.
{
"preserveFrontmatterCommentTags": false
}
—frontmatterNamingConvention
The naming convention that variables should be output as.
Accepts either
"camelCase"
or"snakeCase"
. Defaults to"camelCase"
.
Block tags have to be written in camelCase (see tsdoc.org).
This option can configure the output style of frontmatter variables when written to YAML.
{
"frontmatterNamingConvention": "camelCase"
}