feat(content-docs): sidebar category linking to document or auto-gene…

…rated index page (#5830) Co-authored-by: Joshua Chen <[email protected]> Co-authored-by: Armano <[email protected]> Co-authored-by: Alexey Pyltsyn <[email protected]>
facebook · Dec 3, 2021 · cfae5d0 · cfae5d0
1 parent 95f911e
commit cfae5d0
Show file tree

Hide file tree

Showing 105 changed files with 3,900 additions and 812 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -167,7 +167,6 @@ module.exports = {
               'head',
               'tail',
               'initial',
-              'last',
             ],
             message: 'These APIs have their ES counterparts.',
           },

diff --git a/packages/docusaurus-mdx-loader/package.json b/packages/docusaurus-mdx-loader/package.json
@@ -28,7 +28,6 @@
     "escape-html": "^1.0.3",
     "file-loader": "^6.2.0",
     "fs-extra": "^10.0.0",
-    "github-slugger": "^1.4.0",
     "gray-matter": "^4.0.3",
     "mdast-util-to-string": "^2.0.0",
     "remark-emoji": "^2.1.0",
@@ -40,7 +39,6 @@
   "devDependencies": {
     "@docusaurus/types": "2.0.0-beta.9",
     "@types/escape-html": "^1.0.1",
-    "@types/github-slugger": "^1.3.0",
     "@types/mdast": "^3.0.7",
     "@types/stringify-object": "^3.3.1",
     "@types/unist": "^2.0.6",

diff --git a/packages/docusaurus-mdx-loader/src/remark/headings/index.ts b/packages/docusaurus-mdx-loader/src/remark/headings/index.ts
@@ -7,19 +7,16 @@
 
 /* Based on remark-slug (https://github.com/remarkjs/remark-slug) and gatsby-remark-autolink-headers (https://github.com/gatsbyjs/gatsby/blob/master/packages/gatsby-remark-autolink-headers) */
 
-import {parseMarkdownHeadingId} from '@docusaurus/utils';
+import {parseMarkdownHeadingId, createSlugger} from '@docusaurus/utils';
 import visit, {Visitor} from 'unist-util-visit';
 import toString from 'mdast-util-to-string';
-import Slugger from 'github-slugger';
 import type {Transformer} from 'unified';
 import type {Parent} from 'unist';
 import type {Heading, Text} from 'mdast';
 
-const slugs = new Slugger();
-
 function headings(): Transformer {
   const transformer: Transformer = (ast) => {
-    slugs.reset();
+    const slugs = createSlugger();
 
     const visitor: Visitor<Heading> = (headingNode) => {
       const data = headingNode.data || (headingNode.data = {});
@@ -29,7 +26,7 @@ function headings(): Transformer {
       let {id} = properties;
 
       if (id) {
-        id = slugs.slug(id, true);
+        id = slugs.slug(id, {maintainCase: true});
       } else {
         const headingTextNodes = headingNode.children.filter(
           ({type}) => !['html', 'jsx'].includes(type),

diff --git a/.../src/__tests__/__fixtures__/versioned-site/versioned_sidebars/version-1.0.1-sidebars.json b/.../src/__tests__/__fixtures__/versioned-site/versioned_sidebars/version-1.0.1-sidebars.json
@@ -1,7 +1,7 @@
 {
-  "version-1.0.1/docs": {
+  "VersionedSideBarNameDoesNotMatter/docs": {
     "Test": [
-      "version-1.0.1/foo/bar"
+      "foo/bar"
     ],
     "Guides": [
       "version-1.0.1/hello"

diff --git a/packages/docusaurus-plugin-content-docs/src/__tests__/__snapshots__/cli.test.ts.snap b/packages/docusaurus-plugin-content-docs/src/__tests__/__snapshots__/cli.test.ts.snap
@@ -2,122 +2,64 @@
 
 exports[`docsVersion first time versioning 1`] = `
 Object {
-  "version-1.0.0/docs": Array [
-    Object {
-      "collapsed": true,
-      "collapsible": true,
-      "items": Array [
-        Object {
-          "collapsed": true,
-          "collapsible": true,
-          "items": Array [
-            Object {
-              "id": "version-1.0.0/foo/bar",
-              "type": "doc",
-            },
-            Object {
-              "id": "version-1.0.0/foo/baz",
-              "type": "doc",
-            },
-          ],
-          "label": "foo",
-          "type": "category",
-        },
-        Object {
-          "collapsed": true,
-          "collapsible": true,
-          "items": Array [
-            Object {
-              "id": "version-1.0.0/rootAbsoluteSlug",
-              "type": "doc",
-            },
-            Object {
-              "id": "version-1.0.0/rootRelativeSlug",
-              "type": "doc",
-            },
-            Object {
-              "id": "version-1.0.0/rootResolvedSlug",
-              "type": "doc",
-            },
-            Object {
-              "id": "version-1.0.0/rootTryToEscapeSlug",
-              "type": "doc",
-            },
-          ],
-          "label": "Slugs",
-          "type": "category",
-        },
-        Object {
-          "id": "version-1.0.0/headingAsTitle",
-          "type": "doc",
-        },
-        Object {
-          "href": "https://github.com",
-          "label": "Github",
-          "type": "link",
-        },
-        Object {
-          "id": "version-1.0.0/hello",
-          "type": "ref",
-        },
-      ],
-      "label": "Test",
-      "type": "category",
-    },
-    Object {
-      "collapsed": true,
-      "collapsible": true,
-      "items": Array [
-        Object {
-          "id": "version-1.0.0/hello",
-          "type": "doc",
-        },
-      ],
-      "label": "Guides",
-      "type": "category",
-    },
-  ],
+  "docs": Object {
+    "Guides": Array [
+      "hello",
+    ],
+    "Test": Array [
+      Object {
+        "items": Array [
+          "foo/bar",
+          "foo/baz",
+        ],
+        "label": "foo",
+        "type": "category",
+      },
+      Object {
+        "items": Array [
+          "rootAbsoluteSlug",
+          "rootRelativeSlug",
+          "rootResolvedSlug",
+          "rootTryToEscapeSlug",
+        ],
+        "label": "Slugs",
+        "type": "category",
+      },
+      Object {
+        "id": "headingAsTitle",
+        "type": "doc",
+      },
+      Object {
+        "href": "https://github.com",
+        "label": "Github",
+        "type": "link",
+      },
+      Object {
+        "id": "hello",
+        "type": "ref",
+      },
+    ],
+  },
 }
 `;
 
 exports[`docsVersion not the first time versioning 1`] = `
 Object {
-  "version-2.0.0/docs": Array [
-    Object {
-      "collapsed": true,
-      "collapsible": true,
-      "items": Array [
-        Object {
-          "id": "version-2.0.0/foo/bar",
-          "type": "doc",
-        },
-      ],
-      "label": "Test",
-      "type": "category",
-    },
-    Object {
-      "collapsed": true,
-      "collapsible": true,
-      "items": Array [
-        Object {
-          "id": "version-2.0.0/hello",
-          "type": "doc",
-        },
-      ],
-      "label": "Guides",
-      "type": "category",
-    },
-  ],
+  "docs": Object {
+    "Guides": Array [
+      "hello",
+    ],
+    "Test": Array [
+      "foo/bar",
+    ],
+  },
 }
 `;
 
 exports[`docsVersion second docs instance versioning 1`] = `
 Object {
-  "version-2.0.0/community": Array [
-    Object {
-      "id": "version-2.0.0/team",
-      "type": "doc",
-    },
+  "community": Array [
+    "team",
   ],
 }
 `;