📝 docs: update some contents

.github/workflows/lint-and-fmt.yml

@@ -74,3 +74,31 @@ jobs:
         working-directory: packages/biliass/rust
         run: |
           cargo clippy --all-targets --all-features -- -D warnings
+
+  lint-and-fmt-docs:
+    name: Lint and Format (Docs)
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v2
+        with:
+          package_json_file: "docs/package.json"
+          version: "latest"
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: "22"
+          cache: "pnpm"
+          cache-dependency-path: "docs/pnpm-lock.yaml"
+
+      - name: Install dependencies
+        working-directory: ./docs
+        run: pnpm i --frozen-lockfile
+
+      - name: Format check
+        working-directory: ./docs
+        run: pnpm fmt:check

.github/workflows/vitepress-deploy.yml

@@ -27,7 +27,7 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: "20"
+          node-version: "22"
           cache: "pnpm"
           cache-dependency-path: "docs/pnpm-lock.yaml"
 

docs/.vitepress/config.mts

@@ -1,31 +1,89 @@
 import { defineConfig } from 'vitepress'
 
 export default defineConfig({
+  lang: 'zh-CN',
   title: 'yutto',
-  description: 'yutto docs',
+  description: '🧊 yutto，一个可爱且任性的 B 站下载器（CLI）',
+  cleanUrls: true,
   themeConfig: {
     nav: [
       { text: '首页', link: '/' },
-      { text: '指引', link: '/guide/quick-start.html' },
+      { text: '指南', link: '/guide/quick-start' },
+      { text: '参考', link: '/reference/cli' },
       { text: '迁移', link: '/migration/' },
+      {
+        text: '支持我',
+        items: [
+          { text: '赞助', link: '/sponsor' },
+          {
+            text: '参与贡献',
+            link: 'https://github.com/yutto-dev/yutto/blob/main/CONTRIBUTING.md',
+          },
+        ],
+      },
     ],
 
     sidebar: {
       '/guide': [
         {
-          text: '',
+          text: '开始',
           items: [
             {
               text: '快速开始',
-              link: '/guide/quick-start.html',
+              link: '/guide/quick-start',
             },
             {
               text: '支持的链接',
-              link: '/guide/supported-links.html',
+              link: '/guide/supported-links',
             },
+          ],
+          collapsed: false,
+        },
+        {
+          text: 'FAQ',
+          link: '/guide/faq',
+        },
+        {
+          text: '交流和反馈',
+          link: '/guide/feedback',
+        },
+        {
+          text: '注意事项',
+          link: '/guide/notice',
+        },
+        {
+          text: '特别感谢',
+          link: '/guide/thanks',
+        },
+      ],
+      '/reference': [
+        {
+          text: '参考',
+          items: [
             {
               text: '命令行参数',
-              link: '/guide/cli.html',
+              link: '/reference/cli',
+            },
+            {
+              text: '配置',
+              link: '/reference/config',
+            },
+            {
+              text: '详细参数',
+              items: [
+                {
+                  text: '基础参数',
+                  link: '/reference/arguments-basic',
+                },
+                {
+                  text: '批量参数',
+                  link: '/reference/arguments-batch',
+                },
+                {
+                  text: '弹幕参数',
+                  link: '/reference/arguments-danmaku',
+                },
+              ],
             },
           ],
         },
@@ -46,5 +104,9 @@ export default defineConfig({
       { icon: 'github', link: 'https://github.com/yutto-dev/yutto' },
       { icon: 'discord', link: 'https://discord.gg/5cQGyFwsqC' },
     ],
+
+    search: {
+      provider: 'local',
+    },
   },
 })

docs/.vitepress/theme/index.css

@@ -6,7 +6,7 @@
   --vp-c-brand-1: #31b1b1;
   --vp-c-brand-2: #29c5ca;
   --vp-c-brand-3: #67e8e2;
-  --vp-c-brand-soft:#29c9cf33;
+  --vp-c-brand-soft: #29c9cf33;
 }
 
 /**

docs/README.md

@@ -6,44 +6,44 @@
 
 ## 内容规划<sup>WIP</sup>
 
--  主页
-
-   -  引导 button 主要是分为「从零开始」和「从 bilili 迁移」，未来可能添加 GitHub button
-   -  features
-
--  指引
-
-   -  引导页 引导到
-      -  安装
-      -  参数
-      -  迁移
-   -  下载安装
-      -  安装引导，使用 button 引导三种主要的安装方式，注意，要更加详细，安装这一步应当确保大家都做好
-      -  包管理器安装
-      -  docker 安装
-      -  pip 安装
-      -  源码安装
-   -  使用
-      -  基础运作方式（并简单引导如何使用参数），链接到参数详情页
-      -  支持的链接
-   -  FAQ
-   -  交流和反馈
-   -  注意事项
-   -  特别感谢
-
--  参数专用页
-
-   -  类似 Vue new docs 的 API page，引导页对各种内容进行罗列，分为「通用参数」……
-   -  各个子页面
-
--  从 bilili 迁移
-
-   -  比当前 README 里更细致，详细说明引导 + 示例
-
--  前往
-   -  V1
-   -  画外音（这里是创作 bilili 及 yutto 的一些历程吧，以我自己的口吻叙述，也为可能是最后的 yutto 作结）
-      -  奇妙的轮回（bilili 与 download-webhook）
--  支持我
-   -  贡献
-   -  赞助
+- 主页
+
+   - 引导 button 主要是分为「从零开始」和「从 bilili 迁移」，未来可能添加 GitHub button
+   - features
+
+- 指引
+
+   - 引导页 引导到
+      - 安装
+      - 参数
+      - 迁移
+   - 下载安装
+      - 安装引导，使用 button 引导三种主要的安装方式，注意，要更加详细，安装这一步应当确保大家都做好
+      - 包管理器安装
+      - docker 安装
+      - pip 安装
+      - 源码安装
+   - 使用
+      - 基础运作方式（并简单引导如何使用参数），链接到参数详情页
+      - 支持的链接
+   - FAQ
+   - 交流和反馈
+   - 注意事项
+   - 特别感谢
+
+- 参数专用页
+
+   - 类似 Vue new docs 的 API page，引导页对各种内容进行罗列，分为「通用参数」……
+   - 各个子页面
+
+- 从 bilili 迁移
+
+   - 比当前 README 里更细致，详细说明引导 + 示例
+
+- 前往
+   - V1
+   - 画外音（这里是创作 bilili 及 yutto 的一些历程吧，以我自己的口吻叙述，也为可能是最后的 yutto 作结）
+      - 奇妙的轮回（bilili 与 download-webhook）
+- 支持我
+   - 贡献
+   - 赞助