Merge pull request #23 from stick-i/docs

feat: 添加基于 VuePress 的文档模板，以及自动部署到 GitHub Page 的配置文件

Author: stick-i

.github/workflows/deploy-docs.yml

@@ -0,0 +1,54 @@
+name: 部署文档
+
+on:
+  push:
+    branches:
+      # 确保这是你正在使用的分支名称
+      - docs
+  # 手动触发部署
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  deploy-gh-pages:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          # 如果你文档需要 Git 子模块，取消注释下一行
+          # submodules: true
+
+      - name: 安装 pnpm
+        uses: pnpm/action-setup@v2
+        with:
+          # 选择要使用的 pnpm 版本
+          version: 8
+          # 使用 pnpm 安装依赖
+          run_install: true
+
+      - name: 设置 Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: pnpm
+          cache-dependency-path: document/web-docs/package.json
+
+      - name: 构建文档
+        env:
+          NODE_OPTIONS: --max_old_space_size=8192
+        run: |-
+          cd document/web-docs
+          pnpm run docs:build
+          > docs/.vuepress/dist/.nojekyll
+
+      - name: 部署文档
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          # 这是文档部署到的分支名称
+          branch: gh-pages
+          folder: document/web-docs/docs/.vuepress/dist

.gitignore

@@ -32,4 +32,11 @@ build/
 .vscode/
 
 ### Mac OS ###
-.DS_Store
+.DS_Store
+
+### vuepress ###
+/document/web-docs/node_modules/
+/document/web-docs/docs/.vuepress/.cache/
+/document/web-docs/docs/.vuepress/.temp/
+/document/web-docs/pnpm-lock.yaml
+/document/web-docs/docs/.vuepress/dist/

README.md

@@ -316,7 +316,8 @@ https://github.com/stick-i/spel-validator/releases
 
 - `main`：主分支，已发布的最新版本代码将合入此分支。
 - `docs`：文档分支，修改文档的内容将提交到这里。
-- `vX.Y.Z`：版本分支，用于开发新版本，已经发布的版本会将分支删除。
+- `vX.Y.Z`：版本分支，用于汇总及验证新版本的功能，已经发布的版本会将分支删除。
+- `dev-xxx`：开发分支，用于开发新功能，每个dev分支都应当对应一个issue，功能开发完成后通过PR合入 `vX.Y.Z` 分支，并删除当前分支。
 
 ## 💰 捐赠支持
 

document/web-docs/docs/.vuepress/config.js

@@ -0,0 +1,17 @@
+import {defaultTheme} from '@vuepress/theme-default'
+import {defineUserConfig} from 'vuepress/cli'
+import {viteBundler} from '@vuepress/bundler-vite'
+
+export default defineUserConfig({
+    lang: 'zh-CN',
+
+    title: 'SpEL Validator',
+    description: '一个强大的 Java 参数校验包，基于 SpEL 实现，扩展自 javax.validation 包，几乎支持所有场景下的参数校验。',
+
+    theme: defaultTheme({
+        logo: 'https://vuejs.press/images/hero.png',
+        navbar: ['/', '/get-started'],
+    }),
+
+    bundler: viteBundler(),
+})

document/web-docs/docs/README.md

@@ -0,0 +1,31 @@
+---
+home: true
+title: Home
+heroImage: https://vuejs.press/images/hero.png
+actions:
+  - text: 快速开始
+    link: /get-started.html
+    type: primary
+
+  - text: 项目介绍
+    link: https://vuejs.press/guide/introduction.html
+    type: secondary
+
+features:
+  - title: 易上手
+    details: 设计直观，简单易用，与 javax.validation 使用方式高度相似，学习成本低，上手快。
+  - title: 极致灵活
+    details: 利用 SpEL（Spring Expression Language）的强大功能，轻松实现复杂验证逻辑，且能够直接调用已注入的 Spring Beans 进行验证。
+  - title: 无缝集成
+    details: 扩展自 javax.validation 包，只新增不修改，无缝集成到现有项目中。
+  - title: 上下文感知
+    details: 能够在整个对象的上下文中进行验证，支持跨字段的逻辑验证，提高数据完整性检查的效率和准确性。
+  - title: 异常友好
+    details: 验证失败时自动整合进 javax.validation 的异常管理体系，简化错误处理流程。
+  - title: 完全可定制
+    details: 支持创建自定义约束注解，允许根据具体业务需求灵活定义验证规则。
+
+footer: Apache-2.0 license | 版权所有 © 2024-至今 阿杆
+---
+
+[default-theme-home]: https://vuejs.press/reference/default-theme/frontmatter.html#home-page

document/web-docs/docs/get-started.md

@@ -0,0 +1 @@
+Test

document/web-docs/package.json

@@ -0,0 +1,19 @@
+{
+    "name": "spel-validator",
+    "version": "0.0.1",
+    "description": "一个强大的 Java 参数校验包，基于 SpEL 实现，扩展自 javax.validation 包，几乎支持所有场景下的参数校验。",
+    "license": "Apache-2.0",
+    "type": "module",
+    "scripts": {
+        "docs:build": "vuepress build docs",
+        "docs:clean-dev": "vuepress dev docs --clean-cache",
+        "docs:dev": "vuepress dev docs",
+        "docs:update-package": "pnpm dlx vp-update"
+    },
+    "devDependencies": {
+        "@vuepress/bundler-vite": "^2.0.0-rc.7",
+        "@vuepress/theme-default": "^2.0.0-rc.11",
+        "vue": "^3.4.38",
+        "vuepress": "2.0.0-rc.15"
+    }
+}