auto generated sidebar

go-kratos · Nov 4, 2021 · 5c41080 · 5c41080
1 parent abbd949
commit 5c41080
Show file tree

Hide file tree

Showing 82 changed files with 76 additions and 90 deletions.
diff --git a/docs/community/contribution.md → docs/community/01-contribution.md b/docs/community/contribution.md → docs/community/01-contribution.md
diff --git a/docs/community/documentation.md → docs/community/02-documentation.md b/docs/community/documentation.md → docs/community/02-documentation.md
diff --git a/docs/community/_category_.yml b/docs/community/_category_.yml
@@ -0,0 +1,2 @@
+label: '开源社区'
+position: 5
diff --git a/docs/component/api.md → docs/component/01-api.md b/docs/component/api.md → docs/component/01-api.md
diff --git a/docs/component/config.md → docs/component/02-config.md b/docs/component/config.md → docs/component/02-config.md
diff --git a/docs/component/encoding.md → docs/component/03-encoding.md b/docs/component/encoding.md → docs/component/03-encoding.md
diff --git a/docs/component/errors.md → docs/component/04-errors.md b/docs/component/errors.md → docs/component/04-errors.md
diff --git a/docs/component/log.md → docs/component/05-log.md b/docs/component/log.md → docs/component/05-log.md
diff --git a/docs/component/metadata.md → docs/component/06-metadata.md b/docs/component/metadata.md → docs/component/06-metadata.md
diff --git a/docs/component/metrics.md → docs/component/07-metrics.md b/docs/component/metrics.md → docs/component/07-metrics.md
diff --git a/docs/component/registry.md → docs/component/08-registry.md b/docs/component/registry.md → docs/component/08-registry.md
diff --git a/docs/component/selector.md → docs/component/09-selector.md b/docs/component/selector.md → docs/component/09-selector.md
diff --git a/docs/component/_category_.yml b/docs/component/_category_.yml
@@ -0,0 +1,2 @@
+label: '框架组件'
+position: 2
diff --git a/docs/component/middleware/overview.md → docs/component/middleware/01-overview.md b/docs/component/middleware/overview.md → docs/component/middleware/01-overview.md
diff --git a/docs/component/middleware/auth.md → docs/component/middleware/02-auth.md b/docs/component/middleware/auth.md → docs/component/middleware/02-auth.md
diff --git a/docs/component/middleware/circuitbreaker.md → ...component/middleware/03-circuitbreaker.md b/docs/component/middleware/circuitbreaker.md → ...component/middleware/03-circuitbreaker.md
diff --git a/docs/component/middleware/logging.md → docs/component/middleware/04-logging.md b/docs/component/middleware/logging.md → docs/component/middleware/04-logging.md
diff --git a/docs/component/middleware/metrics.md → docs/component/middleware/05-metrics.md b/docs/component/middleware/metrics.md → docs/component/middleware/05-metrics.md
diff --git a/docs/component/middleware/ratelimit.md → docs/component/middleware/06-ratelimit.md b/docs/component/middleware/ratelimit.md → docs/component/middleware/06-ratelimit.md
diff --git a/docs/component/middleware/recovery.md → docs/component/middleware/07-recovery.md b/docs/component/middleware/recovery.md → docs/component/middleware/07-recovery.md
diff --git a/docs/component/middleware/tracing.md → docs/component/middleware/08-tracing.md b/docs/component/middleware/tracing.md → docs/component/middleware/08-tracing.md
diff --git a/docs/component/middleware/validate.md → docs/component/middleware/09-validate.md b/docs/component/middleware/validate.md → docs/component/middleware/09-validate.md
diff --git a/docs/component/middleware/_category_.yml b/docs/component/middleware/_category_.yml
@@ -0,0 +1,2 @@
+label: '中间件'
+position: 100
diff --git a/docs/component/transport/overview.md → docs/component/transport/01-overview.md b/docs/component/transport/overview.md → docs/component/transport/01-overview.md
diff --git a/docs/component/transport/http.md → docs/component/transport/02-http.md b/docs/component/transport/http.md → docs/component/transport/02-http.md
diff --git a/docs/component/transport/grpc.md → docs/component/transport/03-grpc.md b/docs/component/transport/grpc.md → docs/component/transport/03-grpc.md
diff --git a/docs/component/transport/_category_.yml b/docs/component/transport/_category_.yml
@@ -0,0 +1,2 @@
+label: '传输协议'
+position: 101
diff --git a/docs/devops/docker.md → docs/devops/01-docker.md b/docs/devops/docker.md → docs/devops/01-docker.md
diff --git a/docs/devops/_category_.yml b/docs/devops/_category_.yml
@@ -0,0 +1,2 @@
+label: '运维指南'
+position: 4
diff --git a/docs/getting-started/start.md → docs/getting-started/01-start.md b/docs/getting-started/start.md → docs/getting-started/01-start.md
diff --git a/docs/getting-started/usage.md → docs/getting-started/02-usage.md b/docs/getting-started/usage.md → docs/getting-started/02-usage.md
diff --git a/docs/getting-started/plugin.md → docs/getting-started/03-plugin.md b/docs/getting-started/plugin.md → docs/getting-started/03-plugin.md
diff --git a/docs/getting-started/examples.md → docs/getting-started/04-examples.md b/docs/getting-started/examples.md → docs/getting-started/04-examples.md
diff --git a/docs/getting-started/_category_.yml b/docs/getting-started/_category_.yml
@@ -0,0 +1,2 @@
+label: '快速开始'
+position: 1
diff --git a/docs/guide/api-protobuf.md → docs/guide/01-api-protobuf.md b/docs/guide/api-protobuf.md → docs/guide/01-api-protobuf.md
diff --git a/docs/guide/openapi.md → docs/guide/02-openapi.md b/docs/guide/openapi.md → docs/guide/02-openapi.md
diff --git a/docs/guide/wire.md → docs/guide/03-wire.md b/docs/guide/wire.md → docs/guide/03-wire.md
diff --git a/docs/guide/ent.md → docs/guide/04-ent.md b/docs/guide/ent.md → docs/guide/04-ent.md
diff --git a/docs/guide/_category_.yml b/docs/guide/_category_.yml
@@ -0,0 +1,2 @@
+label: '用户指南'
+position: 3
diff --git a/docs/intro/overview.md → docs/intro/01-overview.md b/docs/intro/overview.md → docs/intro/01-overview.md
diff --git a/docs/intro/layout.md → docs/intro/02-layout.md b/docs/intro/layout.md → docs/intro/02-layout.md
diff --git a/docs/intro/faq.md → docs/intro/03-faq.md b/docs/intro/faq.md → docs/intro/03-faq.md
diff --git a/docs/intro/_category_.yml b/docs/intro/_category_.yml
@@ -0,0 +1,2 @@
+label: '简介'
+position: 0
diff --git a/...nt-docs/current/community/contribution.md → ...docs/current/community/01-contribution.md b/...nt-docs/current/community/contribution.md → ...docs/current/community/01-contribution.md
diff --git a/...t-docs/current/community/documentation.md → ...ocs/current/community/02-documentation.md b/...t-docs/current/community/documentation.md → ...ocs/current/community/02-documentation.md
diff --git a/...gin-content-docs/current/component/api.md → ...-content-docs/current/component/01-api.md b/...gin-content-docs/current/component/api.md → ...-content-docs/current/component/01-api.md
diff --git a/...-content-docs/current/component/config.md → ...ntent-docs/current/component/02-config.md b/...-content-docs/current/component/config.md → ...ntent-docs/current/component/02-config.md
diff --git a/...ontent-docs/current/component/encoding.md → ...ent-docs/current/component/03-encoding.md b/...ontent-docs/current/component/encoding.md → ...ent-docs/current/component/03-encoding.md
diff --git a/...-content-docs/current/component/errors.md → ...ntent-docs/current/component/04-errors.md b/...-content-docs/current/component/errors.md → ...ntent-docs/current/component/04-errors.md
diff --git a/...gin-content-docs/current/component/log.md → ...-content-docs/current/component/05-log.md b/...gin-content-docs/current/component/log.md → ...-content-docs/current/component/05-log.md
diff --git a/...ontent-docs/current/component/metadata.md → ...ent-docs/current/component/06-metadata.md b/...ontent-docs/current/component/metadata.md → ...ent-docs/current/component/06-metadata.md
diff --git a/...content-docs/current/component/metrics.md → ...tent-docs/current/component/07-metrics.md b/...content-docs/current/component/metrics.md → ...tent-docs/current/component/07-metrics.md
diff --git a/...ontent-docs/current/component/registry.md → ...ent-docs/current/component/08-registry.md b/...ontent-docs/current/component/registry.md → ...ent-docs/current/component/08-registry.md
diff --git a/...ontent-docs/current/component/selector.md → ...ent-docs/current/component/09-selector.md b/...ontent-docs/current/component/selector.md → ...ent-docs/current/component/09-selector.md
diff --git a/.../current/component/middleware/overview.md → ...rrent/component/middleware/01-overview.md b/.../current/component/middleware/overview.md → ...rrent/component/middleware/01-overview.md
diff --git a/...docs/current/component/middleware/auth.md → ...s/current/component/middleware/02-auth.md b/...docs/current/component/middleware/auth.md → ...s/current/component/middleware/02-auth.md
diff --git a/...nt/component/middleware/circuitbreaker.md → ...component/middleware/03-circuitbreaker.md b/...nt/component/middleware/circuitbreaker.md → ...component/middleware/03-circuitbreaker.md
diff --git a/...s/current/component/middleware/logging.md → ...urrent/component/middleware/04-logging.md b/...s/current/component/middleware/logging.md → ...urrent/component/middleware/04-logging.md
diff --git a/...s/current/component/middleware/metrics.md → ...urrent/component/middleware/05-metrics.md b/...s/current/component/middleware/metrics.md → ...urrent/component/middleware/05-metrics.md
diff --git a/...current/component/middleware/ratelimit.md → ...rent/component/middleware/06-ratelimit.md b/...current/component/middleware/ratelimit.md → ...rent/component/middleware/06-ratelimit.md
diff --git a/.../current/component/middleware/recovery.md → ...rrent/component/middleware/07-recovery.md b/.../current/component/middleware/recovery.md → ...rrent/component/middleware/07-recovery.md
diff --git a/...s/current/component/middleware/tracing.md → ...urrent/component/middleware/08-tracing.md b/...s/current/component/middleware/tracing.md → ...urrent/component/middleware/08-tracing.md
diff --git a/.../current/component/middleware/validate.md → ...rrent/component/middleware/09-validate.md b/.../current/component/middleware/validate.md → ...rrent/component/middleware/09-validate.md
diff --git a/...s/current/component/transport/overview.md → ...urrent/component/transport/01-overview.md b/...s/current/component/transport/overview.md → ...urrent/component/transport/01-overview.md
diff --git a/...-docs/current/component/transport/http.md → ...cs/current/component/transport/02-http.md b/...-docs/current/component/transport/http.md → ...cs/current/component/transport/02-http.md
diff --git a/...-docs/current/component/transport/grpc.md → ...cs/current/component/transport/03-grpc.md b/...-docs/current/component/transport/grpc.md → ...cs/current/component/transport/03-grpc.md
diff --git a/...gin-content-docs/current/devops/docker.md → ...-content-docs/current/devops/01-docker.md b/...gin-content-docs/current/devops/docker.md → ...-content-docs/current/devops/01-docker.md
diff --git a/...ent-docs/current/getting-started/start.md → ...-docs/current/getting-started/01-start.md b/...ent-docs/current/getting-started/start.md → ...-docs/current/getting-started/01-start.md
diff --git a/...ent-docs/current/getting-started/usage.md → ...-docs/current/getting-started/02-usage.md b/...ent-docs/current/getting-started/usage.md → ...-docs/current/getting-started/02-usage.md
diff --git a/...nt-docs/current/getting-started/plugin.md → ...docs/current/getting-started/03-plugin.md b/...nt-docs/current/getting-started/plugin.md → ...docs/current/getting-started/03-plugin.md
diff --git a/...-docs/current/getting-started/examples.md → ...cs/current/getting-started/04-examples.md b/...-docs/current/getting-started/examples.md → ...cs/current/getting-started/04-examples.md
diff --git a/...ontent-docs/current/guide/api-protobuf.md → ...ent-docs/current/guide/01-api-protobuf.md b/...ontent-docs/current/guide/api-protobuf.md → ...ent-docs/current/guide/01-api-protobuf.md
diff --git a/...gin-content-docs/current/guide/openapi.md → ...-content-docs/current/guide/02-openapi.md b/...gin-content-docs/current/guide/openapi.md → ...-content-docs/current/guide/02-openapi.md
diff --git a/...plugin-content-docs/current/guide/wire.md → ...gin-content-docs/current/guide/03-wire.md b/...plugin-content-docs/current/guide/wire.md → ...gin-content-docs/current/guide/03-wire.md
diff --git a/...-plugin-content-docs/current/guide/ent.md → ...ugin-content-docs/current/guide/04-ent.md b/...-plugin-content-docs/current/guide/ent.md → ...ugin-content-docs/current/guide/04-ent.md
diff --git a/...in-content-docs/current/intro/overview.md → ...content-docs/current/intro/01-overview.md b/...in-content-docs/current/intro/overview.md → ...content-docs/current/intro/01-overview.md
diff --git a/...ugin-content-docs/current/intro/layout.md → ...n-content-docs/current/intro/02-layout.md b/...ugin-content-docs/current/intro/layout.md → ...n-content-docs/current/intro/02-layout.md
diff --git a/...-plugin-content-docs/current/intro/faq.md → ...ugin-content-docs/current/intro/03-faq.md b/...-plugin-content-docs/current/intro/faq.md → ...ugin-content-docs/current/intro/03-faq.md
diff --git a/i18n/zh/code.json b/i18n/zh/code.json
@@ -192,5 +192,37 @@
   "theme.docs.sidebar.navAriaLabel": {
     "message": "Sidebar navigation",
     "description": "The ARIA label for documentation menu"
+  },
+  "theme.BackToTopButton.buttonAriaLabel": {
+    "message": "Scroll back to top",
+    "description": "The ARIA label for the back to top button"
+  },
+  "theme.blog.archive.title": {
+    "message": "Archive",
+    "description": "The page & hero title of the blog archive page"
+  },
+  "theme.blog.archive.description": {
+    "message": "Archive",
+    "description": "The page & hero description of the blog archive page"
+  },
+  "theme.docs.tagDocListPageTitle.nDocsTagged": {
+    "message": "One doc tagged|{count} docs tagged",
+    "description": "Pluralized label for \"{count} docs tagged\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)"
+  },
+  "theme.docs.tagDocListPageTitle": {
+    "message": "{nDocsTagged} with \"{tagName}\"",
+    "description": "The title of the page for a docs tag"
+  },
+  "theme.navbar.mobileSidebarSecondaryMenu.backButtonLabel": {
+    "message": "← Back to main menu",
+    "description": "The label of the back button to return to main menu, inside the mobile navbar sidebar secondary menu (notably used to display the docs sidebar)"
+  },
+  "theme.navbar.mobileVersionsDropdown.label": {
+    "message": "Versions",
+    "description": "The label for the navbar versions dropdown on mobile view"
+  },
+  "theme.TOCCollapsible.toggleButtonLabel": {
+    "message": "On this page",
+    "description": "The label used by the button on the collapsible TOC component"
   }
 }
diff --git a/i18n/zh/docusaurus-plugin-content-blog/options.json b/i18n/zh/docusaurus-plugin-content-blog/options.json
@@ -0,0 +1,14 @@
+{
+  "title": {
+    "message": "Blog",
+    "description": "The title for the blog used in SEO"
+  },
+  "description": {
+    "message": "Blog",
+    "description": "The description for the blog used in SEO"
+  },
+  "sidebar.title": {
+    "message": "Recent posts",
+    "description": "The label for the left sidebar"
+  }
+}
diff --git a/i18n/zh/docusaurus-plugin-content-docs/current.json b/i18n/zh/docusaurus-plugin-content-docs/current.json
@@ -31,20 +31,24 @@
     "message": "快速开始",
     "description": "The label for category 快速开始 in sidebar docs"
   },
-  "sidebar.docs.category.Middleware": {
-    "message": "Middleware",
-    "description": "The label for category Middleware in sidebar docs"
-  },
-  "sidebar.docs.category.Transport": {
-    "message": "Transport",
-    "description": "The label for category Transport in sidebar docs"
-  },
   "sidebar.docs.category.运维指南": {
     "message": "运维指南",
     "description": "The label for category 运维指南 in sidebar docs"
   },
   "sidebar.docs.category.开源社区": {
     "message": "开源社区",
     "description": "The label for category 开源社区 in sidebar docs"
+  },
+  "sidebar.docs.category.介绍": {
+    "message": "介绍",
+    "description": "The label for category 介绍 in sidebar docs"
+  },
+  "sidebar.docs.category.中间件": {
+    "message": "中间件",
+    "description": "The label for category 中间件 in sidebar docs"
+  },
+  "sidebar.docs.category.传输协议": {
+    "message": "传输协议",
+    "description": "The label for category 传输协议 in sidebar docs"
   }
 }
diff --git a/sidebars.js b/sidebars.js
@@ -1,88 +1,8 @@
 module.exports = {
   docs: [
     {
-      type: 'category',
-      label: '快速开始',
-      collapsed: false,
-      items: [
-        'intro/overview',
-        'getting-started/start',
-        'intro/layout',
-        'getting-started/usage',
-        'getting-started/examples',
-        'getting-started/plugin',
-        'intro/faq'
-      ],
-    },
-    {
-      type: 'category',
-      label: '框架组件',
-      collapsed: false,
-      items: [
-        'component/api',
-        'component/errors',
-        'component/config',
-        'component/log',
-        'component/metrics',
-        'component/registry',
-        'component/encoding',
-        'component/metadata',
-        'component/selector',
-        {
-          type: 'category',
-          label: '中间件',
-          collapsed: false,
-          items: [
-            'component/middleware/overview',
-            'component/middleware/logging',
-            'component/middleware/metrics',
-            'component/middleware/recovery',
-            'component/middleware/tracing',
-            'component/middleware/validate',
-            'component/middleware/auth',
-            'component/middleware/ratelimit',
-            'component/middleware/circuitbreaker',
-          ],
-        },
-        {
-          type: 'category',
-          label: '传输协议',
-          collapsed: false,
-          items: [
-            'component/transport/overview',
-            'component/transport/http',
-            'component/transport/grpc',
-          ],
-        },
-      ],
-    },
-    {
-      type: 'category',
-      label: '用户指南',
-      collapsed: false,
-      items: [
-        'guide/api-protobuf',
-        'guide/openapi',
-        'guide/wire',
-        'guide/ent',
-      ],
-    },
-    {
-      type: 'category',
-      label: '运维指南',
-      collapsed: false,
-      items: [
-        'devops/docker',
-      ],
-    },
-    {
-      type: 'category',
-      label: '开源社区',
-      collapsed: false,
-      items: [
-        'community/contribution',
-        'community/documentation',
-      ],
+      type: 'autogenerated',
+      dirName: '.', // '.' means the current docs folder
     },
   ],
 };