From 8a3faabc824dd85a4de10fc4617fa7f618919b6e Mon Sep 17 00:00:00 2001 From: tgreyuk Date: Fri, 3 May 2024 15:17:24 +0100 Subject: [PATCH] chore(global): update docs --- docs/pages/docs/migration-guide.mdx | 2 +- docs/pages/docs/typedoc-usage.mdx | 2 -- docs/theme.config.jsx | 8 ++++---- 3 files changed, 5 insertions(+), 7 deletions(-) diff --git a/docs/pages/docs/migration-guide.mdx b/docs/pages/docs/migration-guide.mdx index 6a2954e06..4742b8e0f 100644 --- a/docs/pages/docs/migration-guide.mdx +++ b/docs/pages/docs/migration-guide.mdx @@ -19,7 +19,6 @@ import { Callout } from 'nextra/components'; - Improved and cleaner UX configurable with options. - Exported option types and JSON schema. - Exposed navigation structure. -- Handle events output. - Ability to customize static text. - Comprehensive documentation and examples repository. @@ -31,6 +30,7 @@ import { Callout } from 'nextra/components'; ## 💥 Breaking Changes +- The output file structure has changed so you may need to update any cross references into your docs from external sources. - Setting `theme` to `"markdown"` is not required and should be removed. - The option `indexTitle` has been removed. Please use the `"title.indexPage"` key with [`textContentMappings`](/docs/options#textcontentmappings). - The option `allReflectionsHaveOwnDocument` has been removed (this behaviour is now the default). Please see See [`outputFileStrategy`](/docs/options#outputfilestrategy). diff --git a/docs/pages/docs/typedoc-usage.mdx b/docs/pages/docs/typedoc-usage.mdx index 3e8a7c2d1..8c66bd951 100644 --- a/docs/pages/docs/typedoc-usage.mdx +++ b/docs/pages/docs/typedoc-usage.mdx @@ -4,8 +4,6 @@ import { Callout, FileTree } from 'nextra/components'; This plugin is like any other TypeDoc plugin and is fully compatible with the TypeDoc ecosystem, supporting other plugins (not specifically targetting HTML output) and the majority of TypeDoc's options. -Please refer to TypeDoc's [Configuration Options](https://typedoc.org/options/configuration/) for detailed information on how to configure options. - ## Supported TypeDoc Options ### Pre-Render Options diff --git a/docs/theme.config.jsx b/docs/theme.config.jsx index fe23373f3..3c00e8605 100644 --- a/docs/theme.config.jsx +++ b/docs/theme.config.jsx @@ -10,17 +10,17 @@ import { PackageVersion } from './components/package-version'; export default { logo: (
-
+
- TYPEDOC-PLUGIN-MARKDOWN + typedoc-plugin-markdown
),