nit

facebook · Apr 25, 2024 · 7297594 · 7297594
1 parent bf9e811
commit 7297594
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/packages/docusaurus-types/src/config.d.ts b/packages/docusaurus-types/src/config.d.ts
@@ -109,6 +109,9 @@ export type MarkdownConfig = {
    */
   remarkRehypeOptions: RemarkRehypeOptions;
 
+  /**
+   * Options to control the behavior of anchors generated from Markdown headings
+   */
   anchors: MarkdownAnchorsConfig;
 };
 

diff --git a/website/docs/api/docusaurus.config.js.mdx b/website/docs/api/docusaurus.config.js.mdx
@@ -492,7 +492,7 @@ export default {
 | `preprocessor` | `MarkdownPreprocessor` | `undefined` | Gives you the ability to alter the Markdown content string before parsing. Use it as a last-resort escape hatch or workaround: it is almost always better to implement a Remark/Rehype plugin. |
 | `parseFrontMatter` | `ParseFrontMatter` | `undefined` | Gives you the ability to provide your own front matter parser, or to enhance the default parser. Read our [front matter guide](../guides/markdown-features/markdown-features-intro.mdx#front-matter) for details. |
 | `mdx1Compat` | `MDX1CompatOptions` | `{comments: true, admonitions: true, headingIds: true}` | Compatibility options to make it easier to upgrade to Docusaurus v3+. |
-| `anchors` | `MarkdownAnchorsConfig` | `{maintainCase: false}` | Options related to anchors generated from Markdown headings |
+| `anchors` | `MarkdownAnchorsConfig` | `{maintainCase: false}` | Options to control the behavior of anchors generated from Markdown headings |
 | `remarkRehypeOptions` | `object` | `undefined` | Makes it possible to pass custom [`remark-rehype` options](https://github.com/remarkjs/remark-rehype#options). |
 
 ```mdx-code-block
-Original file line number
+Diff line change
@@ Expand Up / @@ -109,6 +109,9 @@ export type MarkdownConfig = { @@
        */
       remarkRehypeOptions: RemarkRehypeOptions;
+      /**
+       * Options to control the behavior of anchors generated from Markdown headings
+       */
       anchors: MarkdownAnchorsConfig;
     };
@@ Expand Down @@