mirror of
https://github.com/facebook/docusaurus.git
synced 2025-05-15 18:17:35 +02:00
docs(blog-only): add warning and improve error log (#9839)
This commit is contained in:
parent
34297bc56d
commit
a296d727b6
2 changed files with 20 additions and 4 deletions
|
@ -86,10 +86,20 @@ export const useAllDocsData = (): {[pluginId: string]: GlobalPluginData} =>
|
||||||
}
|
}
|
||||||
| undefined) ?? StableEmptyObject;
|
| undefined) ?? StableEmptyObject;
|
||||||
|
|
||||||
export const useDocsData = (pluginId: string | undefined): GlobalPluginData =>
|
export const useDocsData = (pluginId: string | undefined): GlobalPluginData => {
|
||||||
usePluginData('docusaurus-plugin-content-docs', pluginId, {
|
try {
|
||||||
failfast: true,
|
return usePluginData('docusaurus-plugin-content-docs', pluginId, {
|
||||||
}) as GlobalPluginData;
|
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
|
// TODO this feature should be provided by docusaurus core
|
||||||
export function useActivePlugin(
|
export function useActivePlugin(
|
||||||
|
|
|
@ -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
|
:::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`.
|
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`.
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue