Merge pull request #2 from srsng/main

8.5日 调整文档结构、内容

Author: srsng

.markdownlint.jsonc

@@ -0,0 +1,6 @@
+{
+  "no-reversed-links": false,
+  "line-length": false,
+  "no-inline-html": false,
+  "first-line-h1": false
+}

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: "灵矽文档中心",
@@ -24,22 +27,12 @@ export default defineConfig({
     outline: [2, 4],
     nav: [
       { text: "主页", link: "/" },
-      { text: "设备操作指南", link: Chapters.xrobot_device },
+      { text: "开发文档", link: Chapters.xrobot_platform },
       { text: "API参考", link: Chapters.xrobot_api },
+      { text: "最佳实践", link: Chapters.xrobot_platform_esp32 },
       { 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

@@ -1,4 +1,5 @@
 <script setup lang="ts">
+import { useData } from "vitepress";
 import {
   ChapterItems,
   Chapters,
@@ -16,27 +17,43 @@ const { chapter: chapter_root, root = true } = defineProps<{
 let chapter_name: string[] = [];
 let tocs: { link: string; text: string }[][] = [];
 
-// console.log(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) => {
-    return item.link !== chapter_root && !item.goback;
+const items = ChapterItems[chapter_root];
+if (!items) {
+  const { page } = useData();
+  console.warn(
+    "Error at gen ChapterContents, chapter_root:",
+    chapter_root,
+    "filePath:",
+    page.value.filePath,
+    "title:",
+    page.value.title
+  );
+} else {
+  items.forEach((subchapter) => {
+    // console.log(subchapter);
+    const t = subchapter.items?.filter((item) => {
+      return item.link !== chapter_root && !item.goback;
+    });
+    if (t) {
+      tocs.push(t);
+      chapter_name.push(subchapter.text);
+    }
   });
-  if (t) {
-    tocs.push(t);
-    chapter_name.push(subchapter.text);
-  }
-});
+}
 
 // console.log("chapter_name:", chapter_name);
 // console.log("tocs:", tocs);
 </script>
 
 <template>
-  <h1 v-if="root">目录</h1>
+  <h2 v-if="root">目录</h2>
   <div v-for="(subchapter, index) in tocs">
-    <h2>{{ chapter_name[index] }}</h2>
-    <ol>
+    <h3>{{ chapter_name[index] }}</h3>
+    <div v-if="subchapter.length === 0"><span>暂无内容</span></div>
+    <ol v-else>
       <li v-for="(item, index2) in subchapter" :key="item.link">
         <ol v-if="isChapter(item.link)">
           <ChapterContents