feat(docs): merge and enable sorting feature

tianzhengithub · May 4, 2023 · d881f05 · d881f05
1 parent 4e3c5ff
commit d881f05
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 90 deletions.
diff --git a/darc-docs/docs/Overview/_category_.json b/darc-docs/docs/Overview/_category_.json
@@ -0,0 +1,8 @@
+{
+  "label": "Overview",
+  "position": 1,
+  "link": {
+    "type": "generated-index",
+    "description": "Overview about darc.js"
+  }
+}
diff --git a/darc-docs/docs/intro.md b/darc-docs/docs/intro.md
diff --git a/darc-docs/docusaurus.config.js b/darc-docs/docusaurus.config.js
@@ -73,31 +73,8 @@ const config = {
                         to: '/',
                     },
                     {
-                        type: 'dropdown',
-                        label: 'DARC Docs',
-                        position: 'left',
-                        items: [
-                            {
-                                type: 'docSidebar',
-                                sidebarId: 'OverviewSiderbar',
-                                label: 'Overview',
-                            },
-                            {
-                                type: 'docSidebar',
-                                sidebarId: 'DARCProtocolSidebar',
-                                label: 'DARC Protocol',
-                            },
-                            {
-                                type: 'docSidebar',
-                                sidebarId: 'DARCjsSiderbar',
-                                label: 'darc.js',
-                            },
-                            {
-                                type: 'docSidebar',
-                                sidebarId: 'blsSidebar',
-                                label: 'By-Law Script',
-                            },
-                        ],
+                        label: 'Docs',
+                        to: '/docs/Overview',
                     },
                     {
                         href: 'https://github.com/project-darc/darc',

diff --git a/darc-docs/sidebars.js b/darc-docs/sidebars.js
@@ -13,25 +13,26 @@
 
 /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
 const sidebars = {
-  // By default, Docusaurus generates a sidebar from the docs folder structure
-  tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],
-    DARCProtocolSidebar: [{type: 'autogenerated', dirName: 'DARC-Protocol'}],
-    DARCjsSiderbar: [{type: 'autogenerated', dirName: 'darc.js'}],
-    OverviewSiderbar: [{type: 'autogenerated', dirName: 'Overview'}],
-    blsSidebar: [{type: 'autogenerated', dirName: 'By-Law-Script'}],
+    // By default, Docusaurus generates a sidebar from the docs folder structure
+    tutorialSidebar: [
+        {
+            type: 'autogenerated',
+            dirName: '.', // '.' means the current docs folder
+        },
+    ],
 
-  // But you can create a sidebar manually
-  /*
-  tutorialSidebar: [
-    'intro',
-    'hello',
-    {
-      type: 'category',
-      label: 'Tutorial',
-      items: ['tutorial-basics/create-a-document'],
-    },
-  ],
-   */
+    // But you can create a sidebar manually
+    /*
+    tutorialSidebar: [
+      'intro',
+      'hello',
+      {
+        type: 'category',
+        label: 'Tutorial',
+        items: ['tutorial-basics/create-a-document'],
+      },
+    ],
+     */
 };
 
 module.exports = sidebars;