diff --git a/examples/classic/docusaurus.config.js b/examples/classic/docusaurus.config.js index 2b8cdb8e866e..d6d2a62a94a9 100644 --- a/examples/classic/docusaurus.config.js +++ b/examples/classic/docusaurus.config.js @@ -13,6 +13,11 @@ const config = { title: 'My Site', tagline: 'Dinosaurs are cool', favicon: 'img/favicon.ico', + siteConfig: { + markdown: { + onUnusedDirective: 'throw' + } + }, // Set the production url of your site here url: 'https://your-docusaurus-site.example.com', diff --git a/packages/docusaurus-types/src/config.d.ts b/packages/docusaurus-types/src/config.d.ts index 26b7022cf3d9..34ca4f034098 100644 --- a/packages/docusaurus-types/src/config.d.ts +++ b/packages/docusaurus-types/src/config.d.ts @@ -19,6 +19,10 @@ export type ReportingSeverity = 'ignore' | 'log' | 'warn' | 'throw'; export type RouterType = 'browser' | 'hash'; +export type SiteConfig = { + markdown: {onUnusedDirective: 'throw'}; +}; + export type ThemeConfig = { [key: string]: unknown; }; @@ -316,6 +320,16 @@ export type DocusaurusConfig = { * @default {} */ themeConfig: ThemeConfig; + /** + * The [site configuration](https://docusaurus.io/docs/api/docusaurus-config) + * object to customize your site configuration like markdown. For example: throw error + * if any unused markdown directive is found. + * + * @see https://docusaurus.io/docs/api/docusaurus-config#siteConfig + * @default {} + */ + // TODO: Docs to be added for this + siteConfig: SiteConfig; /** * List of plugins. * diff --git a/packages/docusaurus-types/src/index.d.ts b/packages/docusaurus-types/src/index.d.ts index a6cb0b00b483..0bb8ecaca6aa 100644 --- a/packages/docusaurus-types/src/index.d.ts +++ b/packages/docusaurus-types/src/index.d.ts @@ -17,6 +17,7 @@ export { FasterConfig, StorageConfig, Config, + SiteConfig, } from './config'; export {