🎨 Format docs

Mar-7th · May 26, 2024 · 85851a4 · 85851a4
1 parent 424988a
commit 85851a4
Show file tree

Hide file tree

Showing 35 changed files with 98 additions and 385 deletions.
diff --git a/docs/.vuepress/config.ts b/docs/.vuepress/config.ts
@@ -1,6 +1,5 @@
 import { defineUserConfig } from "vuepress";
-import { redirectPlugin } from "vuepress-plugin-redirect";
-import { searchProPlugin } from "vuepress-plugin-search-pro";
+import { viteBundler } from "@vuepress/bundler-vite";
 import theme from "./theme.js";
 
 export default defineUserConfig({
@@ -21,24 +20,7 @@ export default defineUserConfig({
 
   theme,
 
-  plugins: [
-    redirectPlugin({
-      autoLocale: true,
-      switchLocale: "modal",
-    }),
-    searchProPlugin({
-      indexContent: true,
-      locales: {
-        "/zh/": {
-          placeholder: "搜索",
-        },
-
-        "/en/": {
-          placeholder: "Search",
-        },
-      },
-    }),
-  ],
+  bundler: viteBundler(),
 
   // Enable it with pwa
   // shouldPrefetch: false,

diff --git a/docs/.vuepress/navbar/en.ts b/docs/.vuepress/navbar/en.ts
@@ -1,26 +1,3 @@
 import { navbar } from "vuepress-theme-hope";
 
-export const enNavbar = navbar([
-  "/en/",
-  { text: "Install", icon: "install", link: "/en/install/" },
-  {
-    text: "Guide",
-    icon: "read",
-    prefix: "/en/guide/",
-    children: [
-      {
-        text: "Bar",
-        icon: "creative",
-        prefix: "bar/",
-        children: ["baz", { text: "...", icon: "more", link: "" }],
-      },
-      {
-        text: "Foo",
-        icon: "config",
-        prefix: "foo/",
-        children: ["ray", { text: "...", icon: "more", link: "" }],
-      },
-    ],
-  },
-  { text: "Resource", icon: "pic", link: "/en/resource/" },
-]);
+export const enNavbar = navbar(["/en/", { text: "Resource", icon: "ph:package", link: "/en/resource/" }]);
diff --git a/docs/.vuepress/navbar/zh.ts b/docs/.vuepress/navbar/zh.ts
@@ -1,26 +1,3 @@
 import { navbar } from "vuepress-theme-hope";
 
-export const zhNavbar = navbar([
-  "/zh/",
-  { text: "安装", icon: "insatll", link: "/zh/install/" },
-  {
-    text: "指南",
-    icon: "read",
-    prefix: "/zh/guide/",
-    children: [
-      {
-        text: "Bar",
-        icon: "creative",
-        prefix: "bar/",
-        children: ["baz", { text: "...", icon: "more", link: "" }],
-      },
-      {
-        text: "Foo",
-        icon: "config",
-        prefix: "foo/",
-        children: ["ray", { text: "...", icon: "more", link: "" }],
-      },
-    ],
-  },
-  { text: "资源", icon: "pic", link: "/zh/resource/" },
-]);
+export const zhNavbar = navbar(["/zh/", { text: "资源", icon: "ph:package", link: "/zh/resource/" }]);
diff --git a/docs/.vuepress/public/logo.png b/docs/.vuepress/public/logo.png
diff --git a/docs/.vuepress/sidebar/en.ts b/docs/.vuepress/sidebar/en.ts
@@ -3,21 +3,9 @@ import { sidebar } from "vuepress-theme-hope";
 export const enSidebar = sidebar({
   "/en/": [
     "",
-    {
-      text: "Install",
-      icon: "install",
-      prefix: "install/",
-      children: "structure",
-    },
-    {
-      text: "Guide",
-      icon: "read",
-      prefix: "guide/",
-      children: "structure",
-    },
     {
       text: "Resource",
-      icon: "pic",
+      icon: "ph:package",
       prefix: "resource/",
       children: "structure",
     },

diff --git a/docs/.vuepress/sidebar/zh.ts b/docs/.vuepress/sidebar/zh.ts
@@ -3,21 +3,9 @@ import { sidebar } from "vuepress-theme-hope";
 export const zhSidebar = sidebar({
   "/zh/": [
     "",
-    {
-      text: "安装",
-      icon: "install",
-      prefix: "install/",
-      children: "structure",
-    },
-    {
-      text: "指南",
-      icon: "read",
-      prefix: "guide/",
-      children: "structure",
-    },
     {
       text: "资源",
-      icon: "pic",
+      icon: "ph:package",
       prefix: "resource/",
       children: "structure",
     },

diff --git a/docs/.vuepress/theme.ts b/docs/.vuepress/theme.ts
@@ -8,10 +8,10 @@ export default hopeTheme({
     name: "Mar-7th",
     url: "https://github.com/Mar-7th",
   },
-  iconAssets: "iconfont",
+  iconAssets: "iconify",
   logo: "/logo.png",
   repo: "Mar-7th/March7th-Docs",
-  docsBranch: 'master',
+  docsBranch: "master",
   docsDir: "docs",
 
   locales: {
@@ -45,15 +45,14 @@ export default hopeTheme({
         editLink: "Edit this page on GitHub",
       },
     },
-
   },
 
-//   encrypt: {
-//     config: {
-//       "/zh/demo/encrypt.html": ["1234"],
-//       "/en/demo/encrypt.html": ["1234"],
-//     },
-//   },
+  //   encrypt: {
+  //     config: {
+  //       "/zh/demo/encrypt.html": ["1234"],
+  //       "/en/demo/encrypt.html": ["1234"],
+  //     },
+  //   },
 
   plugins: {
     // comment: {
@@ -65,25 +64,15 @@ export default hopeTheme({
     mdEnhance: {
       align: true,
       attrs: true,
-      chart: true,
       codetabs: true,
+      component: true,
       demo: true,
-      echarts: true,
       figure: true,
-      flowchart: true,
-      gfm: true,
       imgLazyload: true,
       imgSize: true,
       include: true,
-      katex: true,
       mark: true,
-      mermaid: true,
-      playground: {
-        presets: ["ts", "vue"],
-      },
-      presentation: {
-        plugins: ["highlight", "math", "search", "notes", "zoom"],
-      },
+      spoiler: true,
       stylize: [
         {
           matcher: "Recommended",
@@ -100,8 +89,25 @@ export default hopeTheme({
       sub: true,
       sup: true,
       tabs: true,
+      tasklist: true,
       vPre: true,
-      vuePlayground: true,
+    },
+
+    search: {
+      locales: {
+        "/zh/": {
+          placeholder: "搜索",
+        },
+
+        "/en/": {
+          placeholder: "Search",
+        },
+      },
+    },
+
+    redirect: {
+      autoLocale: true,
+      switchLocale: "modal",
     },
 
     // uncomment these if you want a pwa

diff --git a/docs/en/README.md b/docs/en/README.md
@@ -1,43 +1,33 @@
 ---
 home: true
-icon: home
+icon: ph:star
 title: Home
 heroImage: /logo.png
 heroText: March7th
-tagline: Honkai Star Rail bot based on Nonebot2.
+tagline: Honkai Star Rail tools.
 actions:
-  - text: Install 💡
-    link: /en/install/
+  - text: Resource 💡
+    link: /en/resource/
     type: primary
 
-  - text: Docs
-    link: /en/guide/
+  - text: GitHub
+    link: https://github.com/Mar-7th
 
 features:
-  - title: HelpMenu
-    icon: markdown
-    details: Draw StarRail help menu
-    link: #
+  - title: MiHoMo API
+    icon: ph:link-simple-horizontal
+    details: Public account data API
+    link: /en/resource/mihomo_api.html
 
-  - title: AccountBind
-    icon: link
-    details: Bind StarRail UID
-    link: #
+  - title: StarRailRes
+    icon: ph:images-square
+    details: Game data and image resources
+    link: /en/resource/
 
-  - title: AccountInfo
-    icon: profile
-    details: Draw info of account
-    link: #
-
-  - title: GameMemo
-    icon: diagram
-    details: Memo & month statistics
-    link: #
-
-  - title: GameWiki
-    icon: info
-    details: Wiki of characters, etc.
-    link: #
+  - title: StarRailScore
+    icon: ph:scales
+    details: Relic scoring criteria
+    link: https://github.com/Mar-7th/StarRailScore
 
 copyright: false
 footer: MIT Licensed | © 2023-present Mar-7th

diff --git a/docs/en/guide/README.md b/docs/en/guide/README.md
diff --git a/docs/en/guide/bar/README.md b/docs/en/guide/bar/README.md
diff --git a/docs/en/guide/bar/baz.md b/docs/en/guide/bar/baz.md
diff --git a/docs/en/guide/foo/README.md b/docs/en/guide/foo/README.md
diff --git a/docs/en/guide/foo/ray.md b/docs/en/guide/foo/ray.md
diff --git a/docs/en/install/README.md b/docs/en/install/README.md
diff --git a/docs/en/install/environment.md b/docs/en/install/environment.md
diff --git a/docs/en/resource/README.md b/docs/en/resource/README.md
@@ -1,6 +1,6 @@
 ---
 title: Resource
-icon: pic
+icon: ph:package
 index: false
 category:
   - Resource