✨ 更新依赖项，添加 litedoc 和 vitepress-sidebar；修改 .gitignore 以排除生成的文档目录；修正文档链接格式

docs/.vitepress/config/common.ts

@@ -1,3 +1,44 @@
+import { VitePressSidebarOptions } from "vitepress-sidebar/types"
+
 export const gitea = {
     svg: '<svg t="1725391346807" class="icon" viewBox="0 0 1025 1024" version="1.1" xmlns="http://www.w3.org/2000/svg" p-id="5067" width="256" height="256"><path d="M1004.692673 466.396616l-447.094409-447.073929c-25.743103-25.763582-67.501405-25.763582-93.264987 0l-103.873521 103.873521 78.171378 78.171378c12.533635-6.00058 26.562294-9.359266 41.389666-9.359266 53.02219 0 96.00928 42.98709 96.00928 96.00928 0 14.827372-3.358686 28.856031-9.359266 41.389666l127.97824 127.97824c12.533635-6.00058 26.562294-9.359266 41.389666-9.359266 53.02219 0 96.00928 42.98709 96.00928 96.00928s-42.98709 96.00928-96.00928 96.00928-96.00928-42.98709-96.00928-96.00928c0-14.827372 3.358686-28.856031 9.359266-41.389666l-127.97824-127.97824c-3.051489 1.454065-6.184898 2.744293-9.379746 3.870681l0 266.97461c37.273227 13.188988 63.99936 48.721433 63.99936 90.520695 0 53.02219-42.98709 96.00928-96.00928 96.00928s-96.00928-42.98709-96.00928-96.00928c0-41.799262 26.726133-77.331707 63.99936-90.520695l0-266.97461c-37.273227-13.188988-63.99936-48.721433-63.99936-90.520695 0-14.827372 3.358686-28.856031 9.359266-41.389666l-78.171378-78.171378-295.892081 295.871601c-25.743103 25.784062-25.743103 67.542365 0 93.285467l447.114889 447.073929c25.743103 25.743103 67.480925 25.743103 93.264987 0l445.00547-445.00547c25.763582-25.763582 25.763582-67.542365 0-93.285467z" fill="#a2d8f4" p-id="5068"></path></svg>'
+}
+
+export const defaultLang = 'zh'
+
+const commonSidebarOptions = {
+    collapsed: true,
+    convertSameNameSubFileToGroupIndexPage: true,
+    useTitleFromFrontmatter: true,
+
+    useFolderTitleFromIndexFile: true,
+    useFolderLinkFromIndexFile: true,
+    includeFolderIndexFile: true,
+    rootGroupText: 'MARSHOAI',
+}
+
+export function generateSidebarConfig(): VitePressSidebarOptions[] {
+    let sections = ["dev"]
+    let languages = ['zh', 'en']
+    let ret: VitePressSidebarOptions[] = []
+    for (let language of languages) {
+        for (let section of sections) {
+            if (language === defaultLang) {
+                ret.push({
+                    basePath: `/${section}/`,
+                    scanStartPath: `docs/${language}/${section}`,
+                    resolvePath: `/${section}/`,
+                    ...commonSidebarOptions
+                })
+            } else {
+                ret.push({
+                    basePath: `/${language}/${section}/`,
+                    scanStartPath: `docs/${language}/${section}`,
+                    resolvePath: `/${language}/${section}/`,
+                    ...commonSidebarOptions
+                })
+            }
+        }
+    }
+    return ret
 }

docs/.vitepress/config/index.ts

@@ -1,7 +1,8 @@
 import { defineConfig } from 'vitepress'
-import {zh} from './zh'
-import {en} from './en'
-import { gitea } from './common'
+import { zh } from './zh'
+import { en } from './en'
+import { defaultLang, generateSidebarConfig, gitea } from './common'
+import { generateSidebar } from 'vitepress-sidebar'
 
 // https://vitepress.dev/reference/site-config
 export default defineConfig({
@@ -9,8 +10,9 @@ export default defineConfig({
         ['link', { rel: 'icon', type: 'image/x-icon', href: './favicon.ico' }],
     ],
     rewrites: {
-        [`zh/:rest*`]: ":rest*",
+        [`${defaultLang}/:rest*`]: ":rest*",
     },
+    cleanUrls: true,
     themeConfig: {
         // https://vitepress.dev/reference/default-theme-config
         logo: {
@@ -19,9 +21,13 @@ export default defineConfig({
             alt: 'Marsho Logo'
         },
 
+        sidebar: generateSidebar(
+            [...generateSidebarConfig(),]
+        ),
+
         socialLinks: [
             { icon: 'github', link: 'https://github.com/LiteyukiStudio/nonebot-plugin-marshoai' },
-            { icon: gitea, link: 'https://git.liteyuki.icu/LiteyukiStudio/nonebot-plugin-marshoai'}
+            { icon: gitea, link: 'https://git.liteyuki.icu/LiteyukiStudio/nonebot-plugin-marshoai' }
         ]
     },
     locales: {

docs/zh/index.md

@@ -9,10 +9,10 @@ hero:
   actions:
     - theme: brand
       text: 开始使用
-      link: /start
+      link: /start/
     - theme: alt
       text: 开发及扩展
-      link: /dev
+      link: /dev/
   image:
     light: ./marsho-full.svg
     dark: ./marsho-full.svg