Merge pull request #156 from GuoXiCheng/dev-c

add docs
GuoXiCheng · May 31, 2024 · 5f57868 · 5f57868
2 parents 1502633 + 8ce9692
commit 5f57868
Show file tree

Hide file tree

Showing 26 changed files with 1,886 additions and 0 deletions.
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -0,0 +1,66 @@
+# 构建 VitePress 站点并将其部署到 GitHub Pages 的示例工作流程
+#
+name: Deploy VitePress site to Pages
+
+on:
+  # 在针对 `main` 分支的推送上运行。如果你
+  # 使用 `master` 分支作为默认分支，请将其更改为 `master`
+  push:
+    branches: [main]
+
+  # 允许你从 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，请取消注释
+      # - 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 
+      - name: Build with VitePress
+        run: npm run docs:build
+      - name: Release
+        run: npm run release
+      - 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
diff --git a/.gitignore b/.gitignore
@@ -85,3 +85,9 @@ lint/generated/
 lint/outputs/
 lint/tmp/
 # lint/reports/
+
+!package-lock.json
+!package.json
+node_modules/
+docs/.vitepress/cache
+docs/.vitepress/dist
diff --git a/docs/.vitepress/config.js b/docs/.vitepress/config.js
@@ -0,0 +1,24 @@
+// .vitepress/config.js
+export default {
+    // 站点级选项
+    title: 'SKIP Docs',
+    description: 'Just playing around.',
+    base: "/",
+    themeConfig: {
+        nav: [
+            { text: "首页", link: "/" },
+            { text: "指南", link: "/guide/intro/what-is-skip" }
+        ],
+        sidebar: {
+            "/guide/": [
+                {
+                    text: "简介",
+                    items: [{
+                        text: "什么是 SKIP",
+                        link: "/intro/what-is-skip"
+                    }]
+                }
+            ]
+        }
+    }
+}
diff --git a/docs/CNAME b/docs/CNAME
@@ -0,0 +1 @@
+skip.guoxicheng.top
diff --git a/docs/guide/intro/what-is-skip.md b/docs/guide/intro/what-is-skip.md
@@ -0,0 +1,9 @@
+# 基本介绍
+
+## 什么是 SKIP
+
+SKIP 是一款免费开源的安卓应用，旨在利用 Android 无障碍服务帮助用户快速点击 APP 开屏广告的跳过按钮，让你的使用体验更加流畅。
+
+## 主界面预览
+
+![主界面预览](/main-interface-dark.png)
diff --git a/docs/index.md b/docs/index.md
diff --git a/docs/public/android-rect.png b/docs/public/android-rect.png
diff --git a/docs/public/click-button-on-the-screen-dark.png b/docs/public/click-button-on-the-screen-dark.png
diff --git a/docs/public/click-button-on-the-screen-light.png b/docs/public/click-button-on-the-screen-light.png
diff --git a/docs/public/layout-reference.png b/docs/public/layout-reference.png
diff --git a/docs/public/main-interface-dark.png b/docs/public/main-interface-dark.png
diff --git a/docs/public/main-interface-light.png b/docs/public/main-interface-light.png
diff --git a/docs/public/skip-bottom-screenshot.jpg b/docs/public/skip-bottom-screenshot.jpg
diff --git a/docs/public/skip-icon.png b/docs/public/skip-icon.png
diff --git a/docs/public/use-accessibility-dark.png b/docs/public/use-accessibility-dark.png
diff --git a/docs/public/use-accessibility-light.png b/docs/public/use-accessibility-light.png
diff --git a/docs/public/xiaomi-app-backend-lock-dark.png b/docs/public/xiaomi-app-backend-lock-dark.png
diff --git a/docs/public/xiaomi-app-backend-lock-light.png b/docs/public/xiaomi-app-backend-lock-light.png
diff --git a/docs/public/xiaomi-enable-self-start-dark.png b/docs/public/xiaomi-enable-self-start-dark.png
diff --git a/docs/public/xiaomi-enable-self-start-light.png b/docs/public/xiaomi-enable-self-start-light.png
diff --git a/docs/public/xiaomi-enable-self-start.jpg b/docs/public/xiaomi-enable-self-start.jpg
diff --git a/docs/public/xiaomi-ignoring-battery-optimization-dark.png b/docs/public/xiaomi-ignoring-battery-optimization-dark.png
diff --git a/docs/public/xiaomi-ignoring-battery-optimization-light.png b/docs/public/xiaomi-ignoring-battery-optimization-light.png