add docs

.github/workflows/docs.yml

@@ -0,0 +1,64 @@
+# 构建 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: 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

@@ -131,4 +131,5 @@ dist
 
 lib
 src/__tests__/mock/json/*.json
-!src/__tests__/mock/json/mock*.json
+!src/__tests__/mock/json/mock*.json
+docs/.vitepress/cache

docs/.vitepress/config.js

@@ -0,0 +1,35 @@
+// .vitepress/config.js
+export default {
+    // 站点级选项
+    title: 'TinyCRUD Docs',
+    description: 'Just playing around.',
+
+    locales: {
+        root: {
+            label: '简体中文',
+            lang: '/'
+        },
+        en: {
+            label: 'English',
+            lang: 'en',
+        }
+    },
+
+    themeConfig: {
+        nav: [
+            { text: "首页", link: "/" },
+            { text: "指南", link: "/guide/intro/what-is-tinycrud" }
+        ],
+        sidebar: {
+            "/guide/": [
+                {
+                    text: "简介",
+                    items: [{
+                        text: "什么是 TinyCRUD",
+                        link: "/intro/what-is-tinycrud"
+                    }]
+                }
+            ]
+        }
+    }
+}

docs/en/guide/intro/what-is-tinycrud.md

@@ -0,0 +1,57 @@
+# Introduction
+
+## What is TinyCRUD
+
+TinyCRUD is a lightweight data storage library based on the Issue API of code hosting platform, which can use Issue as a database table, Issue comments as data table records, and serialize/deserialize data through Issue API to realize data CRUD.
+
+## Application Scenarios
+
+TinyCRUD is suitable for small teams or personal projects that need simple and lightweight data storage, but do not want or need to set up a complex database system.
+
+## Supported Code Hosting Platforms
+
+<table style="text-align:center">  
+    <tr>
+        <td>
+            <img src="/github.svg" />
+        </td>
+        <td>
+            <img src="/gitlab.svg" />
+        </td>
+        <td>
+            <img src="/gitee.svg" />
+        </td>
+    </tr>
+    <tr>
+        <td>
+            Github API latest
+        </td>
+        <td>
+            Gitlab API v4
+        </td>
+        <td>
+            Gitee API v5
+        </td>
+    </tr>
+</table>
+
+## Supported Request Libraries
+
+<table style="text-align:center">
+    <tr>
+        <td>
+            <img src="https://axios-http.com/assets/logo.svg" />
+        </td>
+        <td>
+            <img src="/wechat.svg" />
+        </td>
+    </tr>
+    <tr>
+        <td>
+            axios
+        </td>
+        <td>
+            wx（WeChat Mini Program）
+        </td>
+    </tr>
+</table>

docs/guide/intro/what-is-tinycrud.md

@@ -0,0 +1,57 @@
+# 基本介绍
+
+## 什么是 TinyCRUD
+
+TinyCRUD 是一个基于代码托管平台 Issue API 的轻量级数据存储库，它可以将 Issue 作为数据库表，Issue 的评论作为数据表记录，通过 Issue API 将数据序列化/反序列化，实现数据的增删改查。
+
+## 适用场景
+
+TinyCRUD 适合用于满足小型团队或个人项目中需要简单、轻量级数据存储，但又不想或不需要设置复杂数据库系统的情况。
+
+## 支持的代码托管平台
+
+<table style="text-align:center">  
+    <tr>
+        <td>
+            <img src="/github.svg" />
+        </td>
+        <td>
+            <img src="/gitlab.svg" />
+        </td>
+        <td>
+            <img src="/gitee.svg" />
+        </td>
+    </tr>
+    <tr>
+        <td>
+            Github API latest
+        </td>
+        <td>
+            Gitlab API v4
+        </td>
+        <td>
+            Gitee API v5
+        </td>
+    </tr>
+</table>
+
+## 支持的请求库
+
+<table style="text-align:center">
+    <tr>
+        <td>
+            <img src="https://axios-http.com/assets/logo.svg" />
+        </td>
+        <td>
+            <img src="/wechat.svg" />
+        </td>
+    </tr>
+    <tr>
+        <td>
+            axios
+        </td>
+        <td>
+            wx（微信小程序）
+        </td>
+    </tr>
+</table>