Add config validation and make all options optional

facebook · Apr 21, 2024 · 6d7f80b · 6d7f80b
1 parent aaa99aa
commit 6d7f80b
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 5 deletions.
diff --git a/packages/docusaurus-types/src/config.d.ts b/packages/docusaurus-types/src/config.d.ts
@@ -103,10 +103,7 @@ export type MarkdownConfig = {
   remarkRehypeOptions: RemarkRehypeOptions;
 
   anchors?: {
-    /**
-     * Ability to preserve the case of the heading anchor links.
-     */
-    maintainCase: boolean;
+    maintainCase?: boolean;
   };
 };
 

diff --git a/packages/docusaurus/src/server/configValidation.ts b/packages/docusaurus/src/server/configValidation.ts
@@ -41,6 +41,9 @@ export const DEFAULT_MARKDOWN_CONFIG: MarkdownConfig = {
     admonitions: true,
     headingIds: true,
   },
+  anchors: {
+    maintainCase: false,
+  },
   remarkRehypeOptions: undefined,
 };
 
@@ -320,6 +323,11 @@ export const ConfigSchema = Joi.object<DocusaurusConfig>({
       // Not sure if it's a good idea, validation is likely to become stale
       // See https://github.com/remarkjs/remark-rehype#options
       Joi.object().unknown(),
+    anchors: Joi.object({
+      maintainCase: Joi.boolean().default(
+        DEFAULT_CONFIG.markdown.anchors?.maintainCase,
+      ),
+    }),
   }).default(DEFAULT_CONFIG.markdown),
 }).messages({
   'docusaurus.configValidationWarning':

diff --git a/website/docs/api/docusaurus.config.js.mdx b/website/docs/api/docusaurus.config.js.mdx
@@ -446,7 +446,7 @@ type MarkdownConfig = {
   mdx1Compat: MDX1CompatOptions;
   remarkRehypeOptions: object; // see https://github.com/remarkjs/remark-rehype#options
   anchors?: {
-    maintainCase: boolean;
+    maintainCase?: boolean;
   };
 };
 ```