chore(global): updated docs for release

typedoc2md · Apr 30, 2024 · 647d03b · 647d03b
1 parent 08e6005
commit 647d03b
Show file tree

Hide file tree

Showing 57 changed files with 1,168 additions and 1,128 deletions.
diff --git a/.changeset/changelog.js b/.changeset/changelog.js
@@ -1,7 +1,7 @@
 const getReleaseLine = async (changeset, _type) => {
   return changeset.summary.replace(
     /\(\#(.+?)\)/g,
-    '([#$1](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/$1))',
+    '([#$1](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/$1))',
   );
 };
 

diff --git a/.changeset/config.json b/.changeset/config.json
@@ -2,7 +2,7 @@
   "$schema": "https://unpkg.com/@changesets/config@2.3.0/schema.json",
   "changelog": [
     "./changelog.js",
-    { "repo": "tgreyuk/typedoc-plugin-markdown" }
+    { "repo": "typedoc2md/typedoc-plugin-markdown" }
   ],
   "commit": false,
   "fixed": [],

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -28,7 +28,7 @@ jobs:
           node-version: ${{ matrix.node }}
           cache: 'npm'
       - name: Install
-        run: npm install
+        run: HUSKY=0 npm install
       - name: Lint
         run: npm run lint --workspace typedoc-plugin-markdown
       - name: Build

diff --git a/README.md b/README.md
@@ -6,21 +6,21 @@ This project is a collection of packages designed for generate TypeScript API do
 
 | Package | Badges | 
 | :---| :---|
-[typedoc-plugin-markdown](./packages/typedoc-plugin-markdown#readme) | ![npm](https://img.shields.io/npm/v/typedoc-plugin-markdown%2Fnext?&logo=npm) ![Downloads](https://img.shields.io/npm/dm/typedoc-plugin-markdown) | 
-[typedoc-plugin-frontmatter](./packages/typedoc-plugin-frontmatter#readme) | ![npm](https://img.shields.io/npm/v/typedoc-plugin-frontmatter%2Fnext?&logo=npm) ![Downloads](https://img.shields.io/npm/dm/typedoc-plugin-frontmatter) | 
-[typedoc-plugin-remark](./packages/typedoc-plugin-remark#readme) | ![npm](https://img.shields.io/npm/v/typedoc-plugin-remark%2Fnext?&logo=npm) ![Downloads](https://img.shields.io/npm/dm/typedoc-plugin-remark) | 
-[typedoc-github-wiki-theme](./packages/typedoc-github-wiki-theme#readme) | ![npm](https://img.shields.io/npm/v/typedoc-github-wiki-theme%2Fnext?&logo=npm) ![Downloads](https://img.shields.io/npm/dm/typedoc-github-wiki-theme) | 
-[typedoc-gitlab-wiki-theme](./packages/typedoc-gitlab-wiki-theme#readme) | ![npm](https://img.shields.io/npm/v/typedoc-gitlab-wiki-theme%2Fnext?&logo=npm) ![Downloads](https://img.shields.io/npm/dm/typedoc-gitlab-wiki-theme) | 
-[typedoc-vitepress-theme](./packages/typedoc-vitepress-theme#readme) | ![npm](https://img.shields.io/npm/v/typedoc-vitepress-theme%2Fnext?&logo=npm) ![Downloads](https://img.shields.io/npm/dm/typedoc-vitepress-theme) | 
-[docusaurus-plugin-typedoc](./packages/docusaurus-plugin-typedoc#readme) | ![npm](https://img.shields.io/npm/v/docusaurus-plugin-typedoc%2Fnext?&logo=npm) ![Downloads](https://img.shields.io/npm/dm/docusaurus-plugin-typedoc) | 
+[typedoc-plugin-markdown](./packages/typedoc-plugin-markdown#readme) | [![npm](https://img.shields.io/npm/v/typedoc-plugin-markdown.svg?logo=npm)](https://www.npmjs.com/package/typedoc-plugin-markdown) ![Downloads](https://img.shields.io/npm/dm/typedoc-plugin-markdown?label=↓) | 
+[typedoc-plugin-frontmatter](./packages/typedoc-plugin-frontmatter#readme) | [![npm](https://img.shields.io/npm/v/typedoc-plugin-frontmatter.svg?logo=npm)](https://www.npmjs.com/package/typedoc-plugin-frontmatter) ![Downloads](https://img.shields.io/npm/dm/typedoc-plugin-frontmatter?label=↓) | 
+[typedoc-plugin-remark](./packages/typedoc-plugin-remark#readme) | [![npm](https://img.shields.io/npm/v/typedoc-plugin-remark.svg?logo=npm)](https://www.npmjs.com/package/typedoc-plugin-remark) ![Downloads](https://img.shields.io/npm/dm/typedoc-plugin-remark?label=↓) | 
+[typedoc-github-wiki-theme](./packages/typedoc-github-wiki-theme#readme) | [![npm](https://img.shields.io/npm/v/typedoc-github-wiki-theme.svg?logo=npm)](https://www.npmjs.com/package/typedoc-github-wiki-theme) ![Downloads](https://img.shields.io/npm/dm/typedoc-github-wiki-theme?label=↓) | 
+[typedoc-gitlab-wiki-theme](./packages/typedoc-gitlab-wiki-theme#readme) | [![npm](https://img.shields.io/npm/v/typedoc-gitlab-wiki-theme.svg?logo=npm)](https://www.npmjs.com/package/typedoc-gitlab-wiki-theme) ![Downloads](https://img.shields.io/npm/dm/typedoc-gitlab-wiki-theme?label=↓) | 
+[typedoc-vitepress-theme](./packages/typedoc-vitepress-theme#readme) | [![npm](https://img.shields.io/npm/v/typedoc-vitepress-theme.svg?logo=npm)](https://www.npmjs.com/package/typedoc-vitepress-theme) ![Downloads](https://img.shields.io/npm/dm/typedoc-vitepress-theme?label=↓) | 
+[docusaurus-plugin-typedoc](./packages/docusaurus-plugin-typedoc#readme) | [![npm](https://img.shields.io/npm/v/docusaurus-plugin-typedoc.svg?logo=npm)](https://www.npmjs.com/package/docusaurus-plugin-typedoc) ![Downloads](https://img.shields.io/npm/dm/docusaurus-plugin-typedoc?label=↓) | 
 
 ## Documentation
 
 Please see [typedoc-plugin-markdown.org](https://typedoc-plugin-markdown.org).
 
 ## Examples
 
-Please see the [examples repository](https://github.com/tgreyuk/typedoc-plugin-markdown-examples).
+Please see the [examples repository](https://github.com/typedoc2md/typedoc-plugin-markdown-examples).
 
 ## Contributing
 

diff --git a/devtools/examples/README.md b/devtools/examples/README.md
@@ -2,5 +2,5 @@ These folder is intended for internal dev purposes.
 
 For plugin examples please visit:
 
-- https://github.com/tgreyuk/typedoc-plugin-markdown-examples
+- https://github.com/typedoc2md/typedoc-plugin-markdown-examples
 - https://github.com/tgreyuk/typedoc-vitepress-theme-example
diff --git a/devtools/packages/prebuild-options/tasks/generate-docs.ts b/devtools/packages/prebuild-options/tasks/generate-docs.ts
@@ -21,9 +21,11 @@ export async function generateOptionsDocs(docsConfig: DocsConfig) {
       `<Callout type="info">These options should be used in conjunction with the core [TypeDoc options](/docs/using-typedoc).</Callout>`,
     );
   } else {
-    out.push(
-      `<Callout type="info">Please view options exposed by [typedoc-plugin-markdown](/docs/options) in addition to those listed here.</Callout>`,
-    );
+    if (docsConfig.presets) {
+      out.push(
+        `<Callout type="info">Please view options exposed by [typedoc-plugin-markdown](/docs/options) in addition to those listed here.</Callout>`,
+      );
+    }
   }
 
   if (docsConfig.presets) {

diff --git a/devtools/scripts/generate-readmes.ts b/devtools/scripts/generate-readmes.ts
@@ -8,10 +8,7 @@ copyChangelog();
 
 async function copyChangelog() {
   const changelog = fs.readFileSync(
-    path.join(
-      __dirname,
-      '../../packages/typedoc-plugin-markdown/CHANGELOG_V4.md',
-    ),
+    path.join(__dirname, '../../packages/typedoc-plugin-markdown/CHANGELOG.md'),
   );
   const readmeContents = changelog
     .toString()
@@ -65,8 +62,8 @@ function writeRepositoryReadme(packages: any) {
   const table: string[] = [];
   const rows = packages.map((packageItem) => {
     const badges = [
-      `![npm](https://img.shields.io/npm/v/${packageItem.name}%2Fnext?\&logo=npm)`,
-      `![Downloads](https://img.shields.io/npm/dm/${packageItem.name})`,
+      `[![npm](https://img.shields.io/npm/v/${packageItem.name}.svg?logo=npm)](https://www.npmjs.com/package/${packageItem.name})`,
+      `![Downloads](https://img.shields.io/npm/dm/${packageItem.name}?label=↓)`,
     ];
     return (
       [
@@ -88,7 +85,7 @@ function writeRepositoryReadme(packages: any) {
   readme.push('## Examples');
 
   readme.push(
-    'Please see the [examples repository](https://github.com/tgreyuk/typedoc-plugin-markdown-examples).',
+    'Please see the [examples repository](https://github.com/typedoc2md/typedoc-plugin-markdown-examples).',
   );
 
   readme.push('## Contributing');
@@ -111,25 +108,28 @@ function writePackageReadme(packageItem: any) {
       : `ci.${packageItem.name}.yml`;
   const readme = [`# ${packageItem.name}`];
   const badges = [
-    `![npm](https://img.shields.io/npm/v/${packageItem.name}%2Fnext?\&logo=npm)`,
-    `[![Build Status](https://github.com/tgreyuk/typedoc-plugin-markdown/actions/workflows/${ciName}/badge.svg?branch=next)](https://github.com/tgreyuk/typedoc-plugin-markdown/actions/workflows/${ciName})`,
+    `[![npm](https://img.shields.io/npm/v/${packageItem.name}.svg?logo=npm)](https://www.npmjs.com/package/${packageItem.name})`,
+    `[![Build Status](https://github.com/typedoc2md/typedoc-plugin-markdown/actions/workflows/${ciName}/badge.svg?branch=main&style=flat-square)](https://github.com/typedoc2md/typedoc-plugin-markdown/actions/workflows/${ciName})`,
   ];
 
   readme.push(badges.join(' '));
-  readme.push(`${packageItem.description}`);
+  readme.push(`> ${packageItem.description}`);
   const docLink = `https://typedoc-plugin-markdown.org${
     DOCS_CONFIG[packageItem.name].docsPath
   }`;
 
   readme.push('## Installation');
   readme.push(`\`\`\`shell
-  npm install ${packageItem.name}@next --save-dev
+  npm install ${packageItem.name} --save-dev
   \`\`\``);
 
   readme.push('## Documentation');
   const resources = [docText(docLink)];
   readme.push(resources.join('\n'));
 
+  readme.push('## License');
+  readme.push('MIT');
+
   fs.writeFileSync(
     `./packages/${packageItem.name}/README.md`,
     readme.join('\n\n'),

diff --git a/docs/pages/api-docs/Class.MarkdownPageEvent.md b/docs/pages/api-docs/Class.MarkdownPageEvent.md
@@ -6,8 +6,8 @@ An event emitted by before and after the markup of a page is rendered.
 
 ```ts
 export function load(app: MarkdownApplication) {
-  app.renderer.on(MarkdownPageEvent.END, (event: MarkdownPageEvent) => {
-   events.contents = event.contents.replace('foo', 'bar');
+  app.renderer.on(MarkdownPageEvent.BEGIN, (page: MarkdownPageEvent) => {
+   page.contents = page.contents.replace('foo', 'bar');
   });
 });
 ```

diff --git a/docs/pages/docs/changelog.mdx b/docs/pages/docs/changelog.mdx
@@ -2,7 +2,7 @@ import { Callout } from 'nextra/components';
 
 # Changelog
 
-## 4.0.0-next.xx
+## 4.0.0 (2024-05-03)
 
 <Callout> v4 is a major release that includes a number of bug fixes, new features and UI improvements.</Callout>
 
@@ -43,32 +43,32 @@ Migrating from v3 to v4 should be fairly straightforward. These pointers will he
 
 The release features numerous bug fixes including:
 
-- Duplication in callback/callable/function properties. ([#581](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/581)).
-- @experimental / @internal annotations. ([#556](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/556))
-- Fix events output and strike-through deprecated items. ([#534](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/534))
-- Class static functions are no longer marked. ([#533](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/533))
-- @example block not rendered with Headline ([#501](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/501))
-- Support for categories ([#499](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/499))
-- Correctly resolve packge readme urls from member pages. ([#483](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/483))
-- Add the ability to add a separate frontmatter for readme file. ([#469](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/469))
-- Items in tables are not linkable. ([#463](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/463))
-- Custom i18n texts. ([#458](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/458))
-- How to improve the formatting for types?. ([#456](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/456))
-- How to change title format. ([#450](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/450))
-- Export Docusaurus plugin options type. ([#440](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/440))
-- How to export interface as a table. ([#403](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/403))
-- Broken Link caused by Typescript class being defined in an index file. ([#402](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/403))
-- Markdown plugin inserts unnecessary escape characters. ([#398](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/398))
-- Potential bug with optional function argument. ([#396](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/396))
-- Respect monorepo `readmeFile` configuration ([#383](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/383))
-- Embed all objects under a Module/Namespace onto single page. ([#338](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/338))
-- Extra spaces when merging lines in a table. ([#331](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/331))
-- Does not support namespace (or module) and interface with same name. ([#300](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/300))
-- Integration with VitePress? ([#287](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/287))
-- Typedoc comments with text wrapped in `<` and `>` breaks Docusaurus Markdown parser. ([#276](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/276))
-- Navigation support? ([#262](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/262))
-- Sidebar Category Support? ([#213](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/213))
-- Properties as Table like function properties. ([#109](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/109))
-- Provide a link/excerpt/screenshot to a demo/example rendered outpout ([#102](https://github.com/tgreyuk/typedoc-plugin-markdown/issues/102))
+- Duplication in callback/callable/function properties. ([#581](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/581)).
+- @experimental / @internal annotations. ([#556](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/556))
+- Fix events output and strike-through deprecated items. ([#534](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/534))
+- Class static functions are no longer marked. ([#533](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/533))
+- @example block not rendered with Headline ([#501](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/501))
+- Support for categories ([#499](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/499))
+- Correctly resolve packge readme urls from member pages. ([#483](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/483))
+- Add the ability to add a separate frontmatter for readme file. ([#469](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/469))
+- Items in tables are not linkable. ([#463](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/463))
+- Custom i18n texts. ([#458](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/458))
+- How to improve the formatting for types?. ([#456](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/456))
+- How to change title format. ([#450](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/450))
+- Export Docusaurus plugin options type. ([#440](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/440))
+- How to export interface as a table. ([#403](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/403))
+- Broken Link caused by Typescript class being defined in an index file. ([#402](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/403))
+- Markdown plugin inserts unnecessary escape characters. ([#398](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/398))
+- Potential bug with optional function argument. ([#396](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/396))
+- Respect monorepo `readmeFile` configuration ([#383](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/383))
+- Embed all objects under a Module/Namespace onto single page. ([#338](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/338))
+- Extra spaces when merging lines in a table. ([#331](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/331))
+- Does not support namespace (or module) and interface with same name. ([#300](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/300))
+- Integration with VitePress? ([#287](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/287))
+- Typedoc comments with text wrapped in `<` and `>` breaks Docusaurus Markdown parser. ([#276](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/276))
+- Navigation support? ([#262](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/262))
+- Sidebar Category Support? ([#213](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/213))
+- Properties as Table like function properties. ([#109](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/109))
+- Provide a link/excerpt/screenshot to a demo/example rendered outpout ([#102](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/102))
 
 
diff --git a/docs/pages/docs/index.mdx b/docs/pages/docs/index.mdx
@@ -19,7 +19,7 @@ Since many tools and platforms support Markdown, the documentation generated by
 - Works alongside other TypeDoc plugins.
 - Configurable output file structure.
 - Configurable UX options
-- [Frontmatter](/plugins/frontmatter) and [Remark](/plugins/remark) utility plugins available.
+- Additonal utility plugins available.
 
 ## Examples
 

diff --git a/docs/pages/docs/quick-start.mdx b/docs/pages/docs/quick-start.mdx
@@ -9,7 +9,7 @@ import { Callout, Steps } from 'nextra/components';
 ## Installation
 
 ```sh npm2yarn
-npm install typedoc typedoc-plugin-markdown@next --save-dev
+npm install typedoc typedoc-plugin-markdown --save-dev
 ```
 
 ## Usage

diff --git a/docs/pages/plugins/_meta.js b/docs/pages/plugins/_meta.js
@@ -13,7 +13,6 @@ export default {
   'github-wiki': 'Github Wiki',
   'gitlab-wiki': 'Gitlab Wiki',
   vitepress: '',
-
   '-- Integrations': {
     type: 'separator',
     title: 'Integrations',

diff --git a/docs/pages/plugins/docusaurus/_meta.js b/docs/pages/plugins/docusaurus/_meta.js
@@ -1,5 +1,16 @@
 export default {
   'quick-start': '',
   options: '',
-  guide: 'Guide',
+  '-- Guide': {
+    type: 'separator',
+    title: 'Guide',
+  },
+  sidebar: '',
+  'multi-instance': '',
+  'watch-mode': '',
+  '-- Support': {
+    type: 'separator',
+    title: 'Support',
+  },
+  'migration-guide': 'Migrating from 0.x.x',
 };
diff --git a/docs/pages/plugins/docusaurus/guide/_meta.js b/docs/pages/plugins/docusaurus/guide/_meta.js
diff --git a/docs/pages/plugins/docusaurus/changelog.mdx → ...es/plugins/docusaurus/migration-guide.mdx b/docs/pages/plugins/docusaurus/changelog.mdx → ...es/plugins/docusaurus/migration-guide.mdx
@@ -1,23 +1,11 @@
-# Changelog
+# 🚀 Migrating from 0.x.x
 
-## 1.0.0-next.xx
-
-> v1 is a new release along with typedoc-plugin-markdown v4.
-
-### 🚀 Migrating from 0.x.x
-
-#### 💥 Breaking Changes
-
-##### typedoc-plugin-Markdown
-
-- Please see typedoc-plugin-markdown migration guide for details on how to migrate from v3 to v4.
-
-##### Sidebar
+## Sidebar
 
 - A manual sidebar file should be referenced in `sidebars.js` rather than autogenerated configuration as previouslly recommended. See [sidebar guide](/plugins/docusaurus/guide/sidebar).
 - With the updated configuration the existing sidebar options `position` and `categoryLabel` are no longer relevant.
 
-##### Other options
+## Options
 
 - `includeExtension` has been removed as this behaviour is now the default.
 - `frontmatter` option has been removed. Please use `typedoc-plugin-frontmatter`.
diff --git a/...ugins/docusaurus/guide/multi-instance.mdx → ...ges/plugins/docusaurus/multi-instance.mdx b/...ugins/docusaurus/guide/multi-instance.mdx → ...ges/plugins/docusaurus/multi-instance.mdx
diff --git a/docs/pages/plugins/docusaurus/quick-start.mdx b/docs/pages/plugins/docusaurus/quick-start.mdx
@@ -7,7 +7,7 @@ import { Callout, Steps, FileTree } from 'nextra/components';
 Install Docusaurus in the root of your project and install the plugin dependencies in the same location as the Docusaurus website directory.
 
 ```sh npm2yarn
-npm install typedoc typedoc-plugin-markdown@next docusaurus-plugin-typedoc@next --save-dev
+npm install typedoc typedoc-plugin-markdown docusaurus-plugin-typedoc --save-dev
 ```
 
 ## Usage
@@ -21,7 +21,7 @@ https://docusaurus.io/docs/installation
 A typical project structure might look like this but can be customized to your needs:
 
 <FileTree>
-  <FileTree.Folder name="docusauruss-website" defaultOpen>
+  <FileTree.Folder name="docusaurus-website" defaultOpen>
     <FileTree.Folder name="build (static site dir)"></FileTree.Folder>
     <FileTree.Folder name="docs" defaultOpen>
       <FileTree.Folder name="api (generated TypeDoc md)"></FileTree.Folder>

diff --git a/...ages/plugins/docusaurus/guide/sidebar.mdx → docs/pages/plugins/docusaurus/sidebar.mdx b/...ages/plugins/docusaurus/guide/sidebar.mdx → docs/pages/plugins/docusaurus/sidebar.mdx
diff --git a/...s/plugins/docusaurus/guide/watch-mode.mdx → docs/pages/plugins/docusaurus/watch-mode.mdx b/...s/plugins/docusaurus/guide/watch-mode.mdx → docs/pages/plugins/docusaurus/watch-mode.mdx
diff --git a/docs/pages/plugins/frontmatter.mdx b/docs/pages/plugins/frontmatter.mdx
@@ -8,26 +8,15 @@ import { faGithub } from '@fortawesome/free-brands-svg-icons';
 
 <PackageDescription pjson={pjson} />
 
+## Overview
+
+This plugin is designed to prepend a YAML frontmatter block to the content of each page generated by TypeDoc. This metadata can be used to configure the page's appearance, layout, and other properties depending on the host platform.
+
 ## Features
 
 - Apply global frontmatter variables to all pages.
 - Configure specific pages with comment tags.
-
-## Installation
-
-```sh npm2yarn
-npm install typedoc-plugin-frontmatter@next --save-dev
-```
-
-## Usage
-
-```json filename="typedoc.json"
-{
-  "plugin": ["typedoc-plugin-markdown", "typedoc-plugin-frontmatter"]
-}
-```
-
-Please see the [option guide](/plugins/frontmatter/options) for available configuration.
+- Ability to customize the frontmatter using a local plugin.
 
 ## Examples
 

diff --git a/docs/pages/plugins/frontmatter/_meta.js b/docs/pages/plugins/frontmatter/_meta.js
@@ -1,4 +1,5 @@
 export default {
+  'quick-start': '',
   options: '',
-  guide: '',
+  customizing: '',
 };