新增标题

Author: hyt1004

.gitignore

@@ -5,7 +5,7 @@ yarn.lock
 /dist
 
 docs/.vitepress/cache/
-
+docs/.vitepress/dist/
 *.mov
 
 test/

README.md

@@ -10,7 +10,17 @@ yarn
 
 ```shell
 yarn docs:dev
-// 浏览器打开
-http://localhost:5173
+```
+浏览器打开 http://localhost:5173
+
+## 部署
+
+```shell
+yarn docs:build
+```
+
+本地预览，执行下列命令后，浏览器打开 http://localhost:4173
+```shell
+yarn docs:preview
 ```
 

docs/.vitepress/config.mts

@@ -1,5 +1,6 @@
 import { defineConfig } from "vitepress";
 import { ChapterItems, Chapters } from "./theme/constrants/route";
+import autoH1 from "./plugins/autoH1";
 
 // https://vitepress.dev/reference/site-config
 export default defineConfig({
@@ -48,5 +49,8 @@ export default defineConfig({
     toc: {
       level: [1, 2, 3, 4],
     },
+    config: (md) => {
+      md.use(autoH1);
+    },
   },
 });

docs/.vitepress/plugins/autoH1.js

@@ -0,0 +1,12 @@
+export default (md) => {
+  const hasH1 = (content) => /^\s*#\s+.+/m.test(content);
+
+  md.core.ruler.before("normalize", "auto_add_h1", (state) => {
+    const { frontmatter } = state.env;
+    const src = state.src;
+    if (frontmatter?.title && !hasH1(src)) {
+      state.src = `# ${frontmatter.title}\n\n` + src;
+    }
+    return false;
+  });
+};

docs/.vitepress/theme/layout.vue

@@ -6,6 +6,7 @@ const { Layout } = DefaultTheme;
 
 <template>
   <Layout>
+    <!-- <template #not-found> 404 not-found </template> -->
     <!-- <template #home-hero-image>  </template> -->
   </Layout>
 </template>

docs/xrobot/api/api.md

@@ -1,6 +1,7 @@
 ---
 title: 通过 API 来绑定设备
 ---
+
 ## 1. 用户注册
 
 ```plain
@@ -227,6 +228,6 @@ authorization Bearer 4fxxxxxxxxxxxxxxxxxxxxxxx
 
 ```
 
-# 11. 声音复刻
+## 11. 声音复刻
 
-见 [声音复刻](./voice-clone.md)
+见 [声音复刻](./voice-clone.md)