From 2264f02b3ffec965db485800dce097364382d2e9 Mon Sep 17 00:00:00 2001 From: tgreyuk Date: Sun, 23 Jun 2024 10:28:21 +0100 Subject: [PATCH] chore(docs): fixed section title --- docs/pages/docs/_meta.js | 2 +- docs/pages/plugins/frontmatter/options.mdx | 2 +- packages/typedoc-plugin-frontmatter/src/options/declarations.ts | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/pages/docs/_meta.js b/docs/pages/docs/_meta.js index fa71d952a..087bd3fad 100644 --- a/docs/pages/docs/_meta.js +++ b/docs/pages/docs/_meta.js @@ -2,7 +2,7 @@ export default { index: 'Introduction', '-- Getting Started': { type: 'separator', - title: 'Guides', + title: 'Getting Started', }, 'quick-start': '', options: '', diff --git a/docs/pages/plugins/frontmatter/options.mdx b/docs/pages/plugins/frontmatter/options.mdx index ad8835d91..563ce92cc 100644 --- a/docs/pages/plugins/frontmatter/options.mdx +++ b/docs/pages/plugins/frontmatter/options.mdx @@ -93,7 +93,7 @@ In addition any non standard tags should be added to a `tsdoc.json` file and add "extends": ["typedoc/tsdoc.json"], "tagDefinitions": [ { - "tagName": "@author", + "tagName": "@customTag", "syntaxKind": "modifier" } ] diff --git a/packages/typedoc-plugin-frontmatter/src/options/declarations.ts b/packages/typedoc-plugin-frontmatter/src/options/declarations.ts index e85b10f62..917d7d110 100644 --- a/packages/typedoc-plugin-frontmatter/src/options/declarations.ts +++ b/packages/typedoc-plugin-frontmatter/src/options/declarations.ts @@ -64,7 +64,7 @@ export const indexFrontmatter: Partial = { * "extends": ["typedoc/tsdoc.json"], * "tagDefinitions": [ * { - * "tagName": "@author", + * "tagName": "@customTag", * "syntaxKind": "modifier" * } * ]