From a296d727b69a508daacabb44416c7713f1b3913f Mon Sep 17 00:00:00 2001 From: ozaki <29860391+OzakIOne@users.noreply.github.com> Date: Fri, 9 Feb 2024 19:34:32 +0100 Subject: [PATCH] docs(blog-only): add warning and improve error log (#9839) --- .../src/client/index.ts | 18 ++++++++++++++---- website/docs/blog.mdx | 6 ++++++ 2 files changed, 20 insertions(+), 4 deletions(-) diff --git a/packages/docusaurus-plugin-content-docs/src/client/index.ts b/packages/docusaurus-plugin-content-docs/src/client/index.ts index 335729b898fd..32dd0d926133 100644 --- a/packages/docusaurus-plugin-content-docs/src/client/index.ts +++ b/packages/docusaurus-plugin-content-docs/src/client/index.ts @@ -86,10 +86,20 @@ export const useAllDocsData = (): {[pluginId: string]: GlobalPluginData} => } | undefined) ?? StableEmptyObject; -export const useDocsData = (pluginId: string | undefined): GlobalPluginData => - usePluginData('docusaurus-plugin-content-docs', pluginId, { - failfast: true, - }) as GlobalPluginData; +export const useDocsData = (pluginId: string | undefined): GlobalPluginData => { + try { + return usePluginData('docusaurus-plugin-content-docs', pluginId, { + failfast: true, + }) as GlobalPluginData; + } catch (error) { + throw new Error( + `You are using a feature of the Docusaurus docs plugin, but this plugin does not seem to be enabled${ + pluginId === 'Default' ? '' : ` (pluginId=${pluginId}` + }`, + {cause: error as Error}, + ); + } +}; // TODO this feature should be provided by docusaurus core export function useActivePlugin( diff --git a/website/docs/blog.mdx b/website/docs/blog.mdx index 43a0c23a53d2..1fb3ace11c1b 100644 --- a/website/docs/blog.mdx +++ b/website/docs/blog.mdx @@ -625,6 +625,12 @@ Don't forget to delete the existing homepage at `./src/pages/index.js` or else t ::: +:::warning + +If you disable the docs plugin, don't forget to delete references to the docs plugin elsewhere in your configuration file. Notably, make sure to remove the docs-related navbar items. + +::: + :::tip There's also a "Docs-only mode" for those who only want to use the docs. Read [Docs-only mode](./guides/docs/docs-introduction.mdx) for detailed instructions or a more elaborate explanation of `routeBasePath`.