✨ Feature: update 2.4.0 docs (#52)

Author: Molunerfinn

.github/workflows/deploy.yml

@@ -0,0 +1,36 @@
+name: Deploy Docs
+
+on:
+  push:
+    branches: [master]
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: yarn
+          cache-dependency-path: yarn.lock
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+
+      - name: Build site
+        run: yarn build
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GH_TOKEN }}
+          publish_branch: gh-pages
+          publish_dir: docs/.vitepress/dist

.github/workflows/main.yml

@@ -61,5 +61,8 @@ typings/
 .next
 
 docs/.vuepress/dist
+docs/.vitepress/dist
+docs/.vitepress/cache
 
-.temp/
+.temp/
+.serena/

.gitignore

@@ -0,0 +1,173 @@
+import { defineConfig, DefaultTheme } from 'vitepress'
+import { getNestedSidebarItems } from './utils/sidebar'
+
+const EDIT_LINK_PATTERN = 'https://github.com/PicGo/PicGo-Doc/edit/master/docs/:path'
+
+const commonNavList = [
+  {
+    text: 'Download', link: 'https://github.com/Molunerfinn/PicGo/releases',
+  },
+  {
+    text: 'PicGo-Core', link: 'https://github.com/PicGo/PicGo-Core',
+  },
+  {
+    text: 'Awesome-PicGo', link: 'https://github.com/PicGo/Awesome-PicGo'
+  }
+]
+
+const zhNav = [
+  { text: '高级技巧', link: '/guide/advance' },
+  ...commonNavList
+]
+
+
+const zhSidebar: DefaultTheme.SidebarItem[] = [
+  {
+    text: '指南',
+    items: [
+      { text: '应用介绍', link: '/guide/', items: getNestedSidebarItems('/guide/'), collapsed: true },
+      { text: '快速开始', link: '/guide/getting-started', items: getNestedSidebarItems('/guide/getting-started'), collapsed: true },
+      { text: '配置手册', link: '/guide/config', items: getNestedSidebarItems('/guide/config'), collapsed: true },
+      { text: '高级技巧', link: '/guide/advance', items: getNestedSidebarItems('/guide/advance'), collapsed: true }
+    ]
+  }
+]
+
+const enNav = [
+  { text: 'Advance Usage', link: '/en/guide/advance' },
+  ...commonNavList
+]
+
+const enSidebar = [
+  {
+    text: 'Guidelines',
+    items: [
+      { text: 'App Overview', link: '/en/guide/', items: getNestedSidebarItems('/en/guide/'), collapsed: true },
+      { text: 'Getting Started', link: '/en/guide/getting-started', items: getNestedSidebarItems('/en/guide/getting-started'), collapsed: true },
+      { text: 'Configuration Manual', link: '/en/guide/config', items: getNestedSidebarItems('/en/guide/config'), collapsed: true },
+      { text: 'Advanced Usage', link: '/en/guide/advance', items: getNestedSidebarItems('/en/guide/advance'), collapsed: true }
+    ]
+  }
+]
+
+const zhThemeConfig = {
+  nav: zhNav,
+  sidebar: {
+    '/guide/': zhSidebar
+  },
+  editLink: {
+    pattern: EDIT_LINK_PATTERN,
+    text: '在 GitHub 上编辑此页'
+  },
+  outline: {
+    label: '本页目录',
+    level: 'deep'
+  }
+} as const
+
+const enThemeConfig = {
+  nav: enNav,
+  sidebar: {
+    '/en/guide/': enSidebar
+  },
+  editLink: {
+    pattern: EDIT_LINK_PATTERN,
+    text: 'Edit this page on GitHub'
+  },
+  outline: {
+    label: 'On this page',
+    level: 'deep'
+  }
+} as const
+
+export default defineConfig({
+  title: 'PicGo',
+  description: '图片上传、管理新体验',
+  base: '/PicGo-Doc/',
+  head: [
+    [
+      'link',
+      {
+        rel: 'icon',
+        href: 'https://raw.githubusercontent.com/Molunerfinn/test/master/picgo/New%20LOGO-150.png'
+      }
+    ]
+  ],
+  themeConfig: {
+    logo: 'https://pics.molunerfinn.com/doc/logo.png',
+    socialLinks: [
+      { icon: 'github', link: 'https://github.com/Molunerfinn/PicGo' }
+    ],
+    search: {
+      provider: 'local',
+      options: {
+        locales: {
+          root: {
+            translations: {
+              button: {
+                buttonText: '搜索',
+                buttonAriaLabel: '搜索'
+              },
+              modal: {
+                displayDetails: '显示详细列表',
+                resetButtonTitle: '重置搜索',
+                backButtonTitle: '关闭搜索',
+                noResultsText: '没有找到结果',
+                footer: {
+                  selectText: '选择',
+                  selectKeyAriaLabel: '回车',
+                  navigateText: '导航',
+                  navigateUpKeyAriaLabel: '上箭头',
+                  navigateDownKeyAriaLabel: '下箭头',
+                  closeText: '关闭',
+                  closeKeyAriaLabel: 'Esc'
+                }
+              }
+            }
+          },
+          en: {
+            translations: {
+              button: {
+                buttonText: 'Search',
+                buttonAriaLabel: 'Search'
+              },
+              modal: {
+                displayDetails: 'Display detailed results',
+                resetButtonTitle: 'Clear search',
+                backButtonTitle: 'Close search',
+                noResultsText: 'No results for this query',
+                footer: {
+                  selectText: 'select',
+                  selectKeyAriaLabel: 'Enter',
+                  navigateText: 'navigate',
+                  navigateUpKeyAriaLabel: 'Arrow up',
+                  navigateDownKeyAriaLabel: 'Arrow down',
+                  closeText: 'close',
+                  closeKeyAriaLabel: 'Escape'
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  locales: {
+    root: {
+      label: '简体中文',
+      lang: 'zh-CN',
+      title: 'PicGo',
+      description: '图片上传、管理新体验',
+      link: '/',
+      themeConfig: zhThemeConfig
+    },
+    en: {
+      label: 'English',
+      lang: 'en-US',
+      title: 'PicGo',
+      description: 'New Experience of Pictures Uploading and Management',
+      link: '/en/',
+      themeConfig: enThemeConfig
+    }
+  }
+})

.travis.yml

@@ -0,0 +1,4 @@
+:root {
+  --vp-c-brand-1: #62A0DD;
+  --vp-button-brand-bg: var(--vp-c-brand-1);
+}

docs/.vitepress/config.mts

@@ -0,0 +1,3 @@
+import DefaultTheme from 'vitepress/theme'
+import './custom.css'
+export default DefaultTheme