📝 docs: move readme contents to static document

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

@@ -74,3 +74,31 @@
         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

@@ -0,0 +1,53 @@
+name: VitePress Deploy
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+  merge_group:
+  workflow_dispatch:
+
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          submodules: true
+
+      - 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: Build VitePress site
+        working-directory: ./docs
+        run: pnpm build
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        # if: github.ref == 'refs/heads/main' # Uncomment this before merge this PR
+        with:
+          personal_token: ${{ secrets.PERSONAL_TOKEN }}
+          publish_dir: docs/.vitepress/dist
+          external_repository: SigureMo/docs
+          publish_branch: yutto
+          force_orphan: true
+          commit_message: ":rocket: deploy: "
+          user_name: "github-actions[bot]"
+          user_email: "github-actions[bot]@users.noreply.github.com"

README.md

@@ -1,7 +1,7 @@
 # yutto<sup>2.0.0</sup>
 
 <p align="center">
-   <img src="./logo/logo.png" width="400px">
+   <img src="./docs/public/logo.png" width="400px">
 </p>
 
 <p align="center">

docs/.gitignore

@@ -0,0 +1,8 @@
+node_modules
+.temp
+.cache
+dist/
+lib/
+*.tsbuildinfo
+.DS_Store
+.vitepress/cache

docs/.prettierignore

@@ -0,0 +1,6 @@
+*.html
+dist/
+node_modules/
+*.min.js
+lib/*
+pnpm-lock.yaml

docs/.prettierrc

@@ -0,0 +1,22 @@
+{
+  "printWidth": 100,
+  "tabWidth": 2,
+  "singleQuote": true,
+  "trailingComma": "es5",
+  "semi": false,
+  "arrowParens": "always",
+  "overrides": [
+    {
+      "files": "*.md",
+      "options": {
+        "tabWidth": 3
+      }
+    },
+    {
+      "files": "*.json5",
+      "options": {
+        "singleQuote": false
+      }
+    }
+  ]
+}

docs/.vitepress/config.mts

@@ -0,0 +1,112 @@
+import { defineConfig } from 'vitepress'
+
+export default defineConfig({
+  lang: 'zh-CN',
+  title: 'yutto',
+  description: '🧊 yutto，一个可爱且任性的 B 站下载器（CLI）',
+  cleanUrls: true,
+  themeConfig: {
+    nav: [
+      { text: '首页', link: '/' },
+      { 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: '开始',
+          items: [
+            {
+              text: '快速开始',
+              link: '/guide/quick-start',
+            },
+            {
+              text: '支持的链接',
+              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: '/reference/cli',
+            },
+            {
+              text: '配置',
+              link: '/reference/config',
+            },
+            {
+              text: '详细参数',
+              items: [
+                {
+                  text: '基础参数',
+                  link: '/reference/arguments-basic',
+                },
+                {
+                  text: '批量参数',
+                  link: '/reference/arguments-batch',
+                },
+                {
+                  text: '弹幕参数',
+                  link: '/reference/arguments-danmaku',
+                },
+              ],
+            },
+          ],
+        },
+      ],
+    },
+
+    footer: {
+      message: 'Released under the GPL3.0 License.',
+      copyright: 'Copyright © 2025-present Nyakku Shigure',
+    },
+
+    editLink: {
+      pattern: 'https://github.com/yutto-dev/yutto/edit/main/docs/:path',
+      text: '为此页提供修改建议',
+    },
+
+    socialLinks: [
+      { icon: 'github', link: 'https://github.com/yutto-dev/yutto' },
+      { icon: 'discord', link: 'https://discord.gg/5cQGyFwsqC' },
+    ],
+
+    search: {
+      provider: 'local',
+    },
+  },
+})

docs/.vitepress/env.d.ts

@@ -0,0 +1,6 @@
+declare module '*.vue' {
+  import type { DefineComponent } from 'vue'
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/ban-types
+  const component: DefineComponent<{}, {}, any>
+  export default component
+}

docs/.vitepress/theme/Layout.vue

@@ -0,0 +1,11 @@
+<script setup lang="ts">
+import DefaultTheme from 'vitepress/theme'
+import Sparkler from './components/Sparkler.vue'
+
+const { Layout } = DefaultTheme
+</script>
+
+<template>
+  <Layout />
+  <Sparkler />
+</template>

docs/.vitepress/theme/components/Sparkler.vue

@@ -0,0 +1,28 @@
+<script setup lang="ts">
+import { ref, onMounted, onBeforeUnmount } from 'vue'
+import { MAX_Z_INDEX } from '@moefy-canvas/core'
+import { Sparkler, SparklerMode } from '@moefy-canvas/theme-sparkler'
+
+const el = ref(null)
+const sparkler = new Sparkler(
+  {
+    mode: SparklerMode.TRAIL,
+  },
+  {
+    opacity: 1,
+    zIndex: MAX_Z_INDEX,
+  }
+)
+
+onMounted(() => {
+  sparkler.mount(el.value!)
+})
+
+onBeforeUnmount(() => {
+  sparkler.unmount()
+})
+</script>
+
+<template>
+  <canvas ref="el"></canvas>
+</template>

docs/.vitepress/theme/index.css

@@ -0,0 +1,23 @@
+/**
+ * Colors
+ * -------------------------------------------------------------------------- */
+
+:root {
+  --vp-c-brand-1: #31b1b1;
+  --vp-c-brand-2: #29c5ca;
+  --vp-c-brand-3: #67e8e2;
+  --vp-c-brand-soft: #29c9cf33;
+}
+
+/**
+ * Component: Button
+ * -------------------------------------------------------------------------- */
+
+:root {
+  --vp-button-brand-text: var(--vp-c-bg-soft);
+  --vp-button-brand-bg: var(--vp-c-brand-2);
+  --vp-button-brand-hover-text: var(--vp-c-bg-soft);
+  --vp-button-brand-hover-bg: var(--vp-c-brand-3);
+  --vp-button-brand-active-text: var(--vp-c-bg-soft);
+  --vp-button-brand-active-bg: var(--vp-c-brand-2);
+}

docs/.vitepress/theme/index.ts

@@ -0,0 +1,13 @@
+import { EnhanceAppContext } from 'vitepress'
+import DefaultTheme from 'vitepress/theme'
+import Layout from './Layout.vue'
+import './index.css'
+
+export default {
+  ...DefaultTheme,
+  Layout,
+  enhanceApp(ctx: EnhanceAppContext) {
+    // extend default theme custom behaviour.
+    DefaultTheme.enhanceApp(ctx)
+  },
+}