add: i18n support for config(including nav)

advancedfx · Dec 19, 2023 · 55b041e · 55b041e
1 parent 7070f6f
commit 55b041e
Show file tree

Hide file tree

Showing 13 changed files with 91 additions and 15 deletions.
diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts
@@ -18,17 +18,6 @@ export default defineConfig({
       },
     ],
   ],
-  locales: {
-    root: {
-      label: "English",
-      lang: "en",
-    },
-    "zh-hans": {
-      label: "简体中文",
-      lang: "zh-hans",
-      link: "/zh-hans/",
-    },
-  },
   lastUpdated: true,
   cleanUrls: true,
 
@@ -51,6 +40,7 @@ export default defineConfig({
     ],
 
     // @ts-ignore
+    // https://github.com/jooy2/vitepress-sidebar
     sidebar: generateSidebar([
       {
         documentRootPath: "/docs",
@@ -60,8 +50,7 @@ export default defineConfig({
         useTitleFromFileHeading: false,
         sortMenusByFrontmatterOrder: true,
         useFolderTitleFromIndexFile: true,
-        collapsed: true,
-        rootGroupCollapsed: false,
+        collapsed: false,
         collapseDepth: 2,
         // ignore other language folders
         excludeFolders: ["zh-hans", "zh-hant"],
@@ -75,13 +64,14 @@ export default defineConfig({
         sortMenusByFrontmatterOrder: true,
         useFolderTitleFromIndexFile: true,
         collapsed: true,
-        rootGroupCollapsed: false,
         collapseDepth: 2,
       },
+      // NOTE: Add more language support
     ]),
 
     socialLinks: [
       { icon: "github", link: "https://github.com/advancedfx/advancedfx" },
+      { icon: "discord", link: "https://discord.gg/e7sgYQcR" },
     ],
 
     search: {
@@ -108,11 +98,56 @@ export default defineConfig({
               },
             },
           },
+          // NOTE: Add more language support
           // "zh-hant": {},
         },
       },
     },
   },
 
+  // i18n
+  locales: {
+    root: {
+      label: "English",
+      lang: "en",
+    },
+
+    // Override Config for Chinese Simplified locale
+    "zh-hans": {
+      label: "简体中文",
+      lang: "zh-hans",
+      link: "/zh-hans/",
+      title: "Advancedfx",
+      description:
+        "Half-Life Advanced Effects (HLAE) is a tool to enrich Source (mainly CS:GO) engine based movie making.",
+      themeConfig: {
+        lastUpdated: {
+          text: "上次更新",
+        },
+        editLink: {
+          pattern: "https://github.com/advancedfx/afx-doc/master/docs/:path",
+          text: "在 GitHub 上编辑此页",
+        },
+        footer: {
+          message: "Made with ❤️ by Advancedfx",
+          copyright: "Copyright © 2023-present xxx",
+        },
+        nav: [
+          { text: "指南", link: "/guides/" },
+          { text: "教程", link: "/tutorials/" },
+          { text: "常见问题", link: "/faq/" },
+          { text: "博客", link: "/blog/" },
+          { text: "发布", link: "/releases/" },
+          { text: "下载", link: "/" }, // TODO: link to download #
+        ],
+      },
+    },
+
+    // NOTE: Add more language support
+
+    // Override Config for Chinese Traditional locale
+    // "zh-hant": {},
+  },
+
   vite: {},
 });
diff --git a/docs/blog/index.md b/docs/blog/index.md
@@ -0,0 +1,5 @@
+---
+sidebar: false
+title: Blog
+order: 50
+---
diff --git a/docs/blog/init.md b/docs/blog/init.md
@@ -0,0 +1,5 @@
+---
+title: Start up
+---
+
+# New afx-doc site~
diff --git a/docs/guides/faq/index.md → docs/faq/index.md b/docs/guides/faq/index.md → docs/faq/index.md
@@ -1,4 +1,4 @@
 ---
-order: 9999
 title: FAQ
+order: 30
 ---
diff --git a/docs/guides/faq/vac.md → docs/faq/vac.md b/docs/guides/faq/vac.md → docs/faq/vac.md
diff --git a/docs/guides/AfxHookSource2/index.md b/docs/guides/AfxHookSource2/index.md
@@ -0,0 +1,4 @@
+---
+title: AfxHookSource2
+---
+# The main file
diff --git a/docs/guides/AfxHookSource2/intro.md b/docs/guides/AfxHookSource2/intro.md
@@ -0,0 +1,5 @@
+---
+title: Intro
+order: 10
+---
+# Counter Strike 2
diff --git a/docs/guides/index.md b/docs/guides/index.md
@@ -1,4 +1,5 @@
 ---
 title: Guide
+order: 10
 ---
 # The main file
diff --git a/docs/releases/index.md b/docs/releases/index.md
@@ -0,0 +1,4 @@
+---
+title: Releases
+order: 40
+---
diff --git a/docs/releases/v0.0.0.md b/docs/releases/v0.0.0.md
@@ -0,0 +1,5 @@
+---
+title: v0.0.0
+---
+
+# v0.0.0
diff --git a/docs/releases/v0.0.1.md b/docs/releases/v0.0.1.md
@@ -0,0 +1,5 @@
+---
+title: v0.0.1
+---
+
+# v0.0.1
diff --git a/docs/tutorials/demo.md b/docs/tutorials/demo.md
@@ -0,0 +1 @@
+# Demo
diff --git a/docs/tutorials/index.md b/docs/tutorials/index.md
@@ -0,0 +1,6 @@
+---
+title: Tutorials
+order: 20
+---
+
+# Tutorials