限制sidebar最多深入两层章节

Author: srsng

docs/.vitepress/config.mts

@@ -1,7 +1,10 @@
 import { defineConfig } from "vitepress";
-import { ChapterItems, Chapters } from "./theme/constrants/route";
+import { Chapters, getChapterItems } from "./theme/constrants/route";
 import autoH1 from "./plugins/autoH1";
 
+// 限制sidebar最多深入两层章节
+const sidebarItems = getChapterItems(1, 2);
+
 // https://vitepress.dev/reference/site-config
 export default defineConfig({
   title: "灵矽文档中心",
@@ -27,18 +30,7 @@ export default defineConfig({
       { text: "API参考", link: Chapters.xrobot_api },
       { text: "FAQ", link: Chapters.xrobot_faq },
     ],
-    sidebar: {
-      "/": [
-        {
-          text: "Examples",
-          items: [
-            { text: "Markdown Examples", link: "/markdown-examples" },
-            { text: "Runtime API Examples", link: "/api-examples" },
-          ],
-        },
-      ],
-      ...ChapterItems,
-    },
+    sidebar: sidebarItems,
     socialLinks: [
       {
         icon: "github",

docs/.vitepress/theme/components/ChapterContents.vue

@@ -16,8 +16,8 @@ const { chapter: chapter_root, root = true } = defineProps<{
 let chapter_name: string[] = [];
 let tocs: { link: string; text: string }[][] = [];
 
-console.log("chapter_root", chapter_root);
-console.log("ChapterItems[chapter_root]", ChapterItems[chapter_root]);
+// console.log("chapter_root", chapter_root);
+// console.log("ChapterItems[chapter_root]", ChapterItems[chapter_root]);
 
 ChapterItems[chapter_root]?.forEach((subchapter) => {
   const t = subchapter.items?.filter((item) => {
@@ -29,8 +29,8 @@ ChapterItems[chapter_root]?.forEach((subchapter) => {
   }
 });
 
-console.log("chapter_name:", chapter_name);
-console.log("tocs:", tocs);
+// console.log("chapter_name:", chapter_name);
+// console.log("tocs:", tocs);
 </script>
 
 <template>

docs/.vitepress/theme/constrants/route.ts

@@ -19,18 +19,18 @@ export enum Chapters {
   // xrobot 主章节
   xrobot = "/xrobot/",
   // guide
-  xrobot_guide = "/xrobot/guide",
-  xrobot_guide_mp = "/xrobot/guide/mini-program",
+  xrobot_guide = "/xrobot/guide/",
+  xrobot_guide_mp = "/xrobot/guide/mini-program/",
   xrobot_guide_device = "/xrobot/guide/device/",
-  xrobot_guide_console = "/xrobot/guide/console",
-  xrobot_guide_net_config = "/xrobot/guide/net-config",
+  xrobot_guide_console = "/xrobot/guide/console/",
+  xrobot_guide_net_config = "/xrobot/guide/net-config/",
   // api
   xrobot_api = "/xrobot/api/",
   xrobot_api_server = "/xrobot/api/server/",
   xrobot_api_client = "/xrobot/api/client/",
   // platform
-  xrobot_platform = "/xrobot/platform",
-  xrobot_platform_esp32 = "/xrobot/platform/esp32",
+  xrobot_platform = "/xrobot/platform/",
+  xrobot_platform_esp32 = "/xrobot/platform/esp32/",
   // faq
   xrobot_faq = "/xrobot/faq/",
 }
@@ -42,6 +42,11 @@ export function isChapter<T extends Record<string, string>>(
   return Object.values(Chapters).includes(link as Chapters);
 }
 
+export function isSubChapter(link: string) {
+  const t = link.split("/").filter((p) => p !== "");
+  return t.length > 1 && isChapter(link);
+}
+
 // // 给 ChapterItem 的 link 字段追加当前章节的 link 前缀
 // // 通过是否包含子items来判断
 // export function apply_prefix2(item: ChapterItem, prefix: Chapters) {
@@ -264,3 +269,23 @@ export const ChapterItems: Record<Chapters, ChapterItem[]> = {
   // faq
   [Chapters.xrobot_faq]: [gobackItem(Chapters.xrobot), ...items_xrobot_faq],
 };
+
+// 获得章节items, 所有level~maxLevel层级的章节
+export function getChapterItems(
+  level?: 1 | 2 | 3 | 4 | 5,
+  maxLevel?: 1 | 2 | 3 | 4 | 5
+) {
+  const _level = level ?? 1;
+  const _maxLevel = maxLevel ?? 6;
+  // 满足条件的ChapterItems的key
+  const chap = Object.values(Chapters).filter((ch) => {
+    const len = ch.split("/").filter((p) => p !== "").length;
+    return _level <= len && len <= _maxLevel;
+  });
+
+  let res = {};
+  chap.forEach((ch) => {
+    res[ch] = ChapterItems[ch];
+  });
+  return res;
+}