💥 use vitepress

.github/workflows/deploy.yml

@@ -0,0 +1,68 @@
+# 构建 VitePress 站点并将其部署到 GitHub Pages 的示例工作流程
+#
+name: Deploy VitePress site to Pages
+
+on:
+  # 在针对 `main` 分支的推送上运行。如果你
+  # 使用 `master` 分支作为默认分支，请将其更改为 `master`
+  push:
+    branches: [main]
+    tags:
+      - v*
+
+  # 允许你从 Actions 选项卡手动运行此工作流程
+  workflow_dispatch:
+
+# 设置 GITHUB_TOKEN 的权限，以允许部署到 GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# 只允许同时进行一次部署，跳过正在运行和最新队列之间的运行队列
+# 但是，不要取消正在进行的运行，因为我们希望允许这些生产部署完成
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  # 构建工作
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # 如果未启用 lastUpdated，则不需要
+      # - uses: pnpm/action-setup@v3 # 如果使用 pnpm，请取消此区域注释
+      #   with:
+      #     version: 9
+      # - uses: oven-sh/setup-bun@v1 # 如果使用 Bun，请取消注释
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: npm # 或 pnpm / yarn
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+      - name: Install dependencies
+        run: npm ci # 或 pnpm install / yarn install / bun install
+      - name: Build with VitePress
+        run: npm run docs:build # 或 pnpm docs:build / yarn docs:build / bun run docs:build
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/.vitepress/dist
+
+  # 部署工作
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: build
+    runs-on: ubuntu-latest
+    name: Deploy
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -18,3 +18,7 @@
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
+
+# Vitepress
+.vitepress/dist
+.vitepress/cache

.vitepress/config/index.mts

@@ -0,0 +1,60 @@
+import { defineConfig } from 'vitepress'
+import nav from './nav'
+import sidebar from './sidebar'
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+  title: "ArcletProject",
+  description: "Document for ArcletProject",
+  head: [
+    ['link', { rel: 'icon', href: '/logo.png' }],
+    ["meta", { "name": "theme-color", "content": "#2564c2" }]
+  ],
+  srcDir: './',
+  srcExclude: ["./old/**", "./README.md"],
+  themeConfig: {
+    // https://vitepress.dev/reference/default-theme-config
+    logo: '/logo.svg',
+    nav: nav,
+    sidebar: sidebar,
+    editLink: {
+      pattern: 'https://github.com/ArcletProject/Documents/edit/refactor/:path',
+      text: '在 GitHub 编辑此页'
+    },
+    socialLinks: [
+      { icon: 'github', link: 'https://github.com/ArcletProject' }
+    ],
+
+    footer: {
+      message: 'MIT License',
+      copyright: 'Copyright © 2025 ArcletProject'
+    },
+    lastUpdated: {
+      text: '上次更新',
+    },
+    outline: {
+      label: '目录',
+      level: [2, 3]
+    },
+    docFooter: {
+      prev: '上一页',
+      next: '下一页'
+    },
+    darkModeSwitchLabel: '黑暗模式',
+    lightModeSwitchTitle: '切换到浅色模式',
+    darkModeSwitchTitle: '切换到黑暗模式',
+    sidebarMenuLabel: '目录',
+    returnToTopLabel: '回到顶部 ▲',
+    externalLinkIcon: true
+  },
+  markdown: {
+    theme: {
+      light: 'min-light',
+      dark: 'one-dark-pro'
+    },
+    image: {
+      lazyLoading: true
+    },
+    lineNumbers: true,
+  }
+})

.vitepress/config/nav.ts

@@ -0,0 +1,4 @@
+export default [
+  { text: '入门', link: '/tutorial/intro.md', activeMatch: '/tutorial/intro.md' },
+  { text: 'Examples', link: '/markdown-examples' , activeMatch: '/markdown-examples' },
+]

.vitepress/config/sidebar.ts

@@ -0,0 +1,37 @@
+const tutorial = [
+  {
+    text: "",
+    items: [
+      { text: "概览", link: "/tutorial/intro.md" },
+    ]
+  },
+  {
+    text: "教程",
+    items: [
+      {
+        text: "Alconna",
+        collapsed: true,
+        items: [
+          { text: "1.8", link: "/tutorial/alconna/v1.md" },
+          { text: "2.0", link: "/tutorial/alconna/v2.md" }
+        ]
+      },
+      {
+        text: "NEPattern",
+        collapsed: true,
+        items: [
+          { text: "0.6", link: "/tutorial/nepattern/v0.md" },
+          { text: "1.0", link: "/tutorial/nepattern/v1.md" }
+        ]
+      },
+      {
+        text: "Letoderea",
+        link: "/tutorial/letoderea.md"
+      },
+    ]
+  }
+]
+
+export default {
+  "/tutorial/": tutorial,
+}

.vitepress/theme/custom_sidebar.css

@@ -0,0 +1,34 @@
+.VPSidebarItem {
+  &.is-link {
+    margin: 4px 0;
+  }
+
+  .items {
+    overflow: hidden;
+  }
+
+  .items:first-child {
+    .VPSidebarItem.is-link:first-child {
+      padding-top: 4px;
+      padding-bottom: 4px;
+      line-height: 24px;
+      font-size: 14px;
+      margin: 0;
+
+      p.text {
+        font-weight: 700;
+        color: var(--vp-c-text-1);
+      }
+
+      &.is-active p.text {
+        color: var(--vp-c-brand);
+      }
+    }
+  }
+
+  .item {
+    p.text {
+      padding: 0;
+    }
+  }
+}

.vitepress/theme/index.ts

@@ -0,0 +1,18 @@
+// https://vitepress.dev/guide/custom-theme
+import { h } from 'vue'
+import type { Theme } from 'vitepress'
+import DefaultTheme from 'vitepress/theme'
+import './style.css'
+import './custom_sidebar.css'
+
+export default {
+  extends: DefaultTheme,
+  Layout: () => {
+    return h(DefaultTheme.Layout, null, {
+      // https://vitepress.dev/guide/extending-default-theme#layout-slots
+    })
+  },
+  enhanceApp({ app, router, siteData }) {
+    // ...
+  }
+} satisfies Theme

.vitepress/theme/style.css

@@ -0,0 +1,147 @@
+/**
+ * Customize default theme styling by overriding CSS variables:
+ * https://github.com/vuejs/vitepress/blob/main/src/client/theme-default/styles/vars.css
+ */
+
+/**
+ * Colors
+ *
+ * Each colors have exact same color scale system with 3 levels of solid
+ * colors with different brightness, and 1 soft color.
+ *
+ * - `XXX-1`: The most solid color used mainly for colored text. It must
+ *   satisfy the contrast ratio against when used on top of `XXX-soft`.
+ *
+ * - `XXX-2`: The color used mainly for hover state of the button.
+ *
+ * - `XXX-3`: The color for solid background, such as bg color of the button.
+ *   It must satisfy the contrast ratio with pure white (#ffffff) text on
+ *   top of it.
+ *
+ * - `XXX-soft`: The color used for subtle background such as custom container
+ *   or badges. It must satisfy the contrast ratio when putting `XXX-1` colors
+ *   on top of it.
+ *
+ *   The soft color must be semi transparent alpha channel. This is crucial
+ *   because it allows adding multiple "soft" colors on top of each other
+ *   to create a accent, such as when having inline code block inside
+ *   custom containers.
+ *
+ * - `default`: The color used purely for subtle indication without any
+ *   special meanings attached to it such as bg color for menu hover state.
+ *
+ * - `brand`: Used for primary brand colors, such as link text, button with
+ *   brand theme, etc.
+ *
+ * - `tip`: Used to indicate useful information. The default theme uses the
+ *   brand color for this by default.
+ *
+ * - `warning`: Used to indicate warning to the users. Used in custom
+ *   container, badges, etc.
+ *
+ * - `danger`: Used to show error, or dangerous message to the users. Used
+ *   in custom container, badges, etc.
+ * -------------------------------------------------------------------------- */
+
+:root {
+  --vp-c-default-1: var(--vp-c-gray-1);
+  --vp-c-default-2: var(--vp-c-gray-2);
+  --vp-c-default-3: var(--vp-c-gray-3);
+  --vp-c-default-soft: var(--vp-c-gray-soft);
+
+  --vp-c-brand-1: var(--vp-c-indigo-1);
+  --vp-c-brand-2: var(--vp-c-indigo-2);
+  --vp-c-brand-3: var(--vp-c-indigo-3);
+  --vp-c-brand-soft: var(--vp-c-indigo-soft);
+
+  --vp-c-tip-1: var(--vp-c-brand-1);
+  --vp-c-tip-2: var(--vp-c-brand-2);
+  --vp-c-tip-3: var(--vp-c-brand-3);
+  --vp-c-tip-soft: var(--vp-c-brand-soft);
+
+  --vp-c-warning-1: var(--vp-c-yellow-1);
+  --vp-c-warning-2: var(--vp-c-yellow-2);
+  --vp-c-warning-3: var(--vp-c-yellow-3);
+  --vp-c-warning-soft: var(--vp-c-yellow-soft);
+
+  --vp-c-danger-1: var(--vp-c-red-1);
+  --vp-c-danger-2: var(--vp-c-red-2);
+  --vp-c-danger-3: var(--vp-c-red-3);
+  --vp-c-danger-soft: var(--vp-c-red-soft);
+}
+
+/**
+ * Component: Button
+ * -------------------------------------------------------------------------- */
+
+:root {
+  --vp-button-brand-border: transparent;
+  --vp-button-brand-text: var(--vp-c-white);
+  --vp-button-brand-bg: var(--vp-c-brand-3);
+  --vp-button-brand-hover-border: transparent;
+  --vp-button-brand-hover-text: var(--vp-c-white);
+  --vp-button-brand-hover-bg: var(--vp-c-brand-2);
+  --vp-button-brand-active-border: transparent;
+  --vp-button-brand-active-text: var(--vp-c-white);
+  --vp-button-brand-active-bg: var(--vp-c-brand-1);
+}
+
+/**
+ * Component: Home
+ * -------------------------------------------------------------------------- */
+
+:root {
+  --vp-home-hero-name-color: transparent;
+  --vp-home-hero-name-background: -webkit-linear-gradient(
+    120deg,
+    #2564c2 30%,
+    #41d1ff
+  );
+
+  /*--vp-home-hero-image-background-image: linear-gradient(*/
+  /*  -45deg,*/
+  /*  #bd34fe 50%,*/
+  /*  #47caff 50%*/
+  /*);*/
+  --vp-home-hero-image-filter: blur(44px);
+}
+
+@media (min-width: 640px) {
+  :root {
+    --vp-home-hero-image-filter: blur(56px);
+  }
+}
+
+@media (min-width: 960px) {
+  :root {
+    --vp-home-hero-image-filter: blur(68px);
+  }
+}
+
+/**
+ * Component: Custom Block
+ * -------------------------------------------------------------------------- */
+
+:root {
+  --vp-custom-block-tip-border: transparent;
+  --vp-custom-block-tip-text: var(--vp-c-text-1);
+  --vp-custom-block-tip-bg: var(--vp-c-brand-soft);
+  --vp-custom-block-tip-code-bg: var(--vp-c-brand-soft);
+}
+
+/**
+ * Component: Algolia
+ * -------------------------------------------------------------------------- */
+
+.DocSearch {
+  --docsearch-primary-color: var(--vp-c-brand-1) !important;
+}
+
+.VPFeatures {
+  @media (min-width: 960px) {
+    .item.grid-4 {
+      width: calc(100% / 3);
+    }
+  }
+}
+