Skip to content

Commit

Permalink
docs(aide-family): 初始化文档构建和部署流程
Browse files Browse the repository at this point in the history
- 新增 GitHub Actions 工作流文件,用于自动构建和部署文档
- 添加 .gitignore 文件,忽略不必要的文件和文件夹
- 创建 package.json 文件,定义文档构建相关的脚本和依赖
  • Loading branch information
aide-cloud committed Nov 12, 2024
0 parents commit 9c7e5a9
Show file tree
Hide file tree
Showing 60 changed files with 6,462 additions and 0 deletions.
52 changes: 52 additions & 0 deletions .github/workflows/deploy-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@

name: 部署文档

on:
push:
branches:
- main

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@v4
with:
version: 8


- name: 设置 Node.js
uses: actions/setup-node@v4
with:
node-version: 20
cache: pnpm

- name: 安装依赖
run: |
corepack enable
pnpm install --frozen-lockfile
- name: 构建文档
env:
NODE_OPTIONS: --max_old_space_size=8192
run: |-
pnpm run docs:build
> src/.vuepress/dist/.nojekyll
- name: 部署文档
uses: JamesIves/github-pages-deploy-action@v4
with:
# 部署文档
branch: gh-pages
folder: src/.vuepress/dist
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@

node_modules/
src/.vuepress/.cache/
src/.vuepress/.temp/
src/.vuepress/dist/
20 changes: 20 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
{
"name": "aide-family.github.io",
"description": "aide-family.github.io",
"version": "2.0.0",
"license": "MIT",
"type": "module",
"scripts": {
"docs:build": "vuepress-vite build src",
"docs:clean-dev": "vuepress-vite dev src --clean-cache",
"docs:dev": "vuepress-vite dev src",
"docs:update-package": "pnpm dlx vp-update"
},
"devDependencies": {
"@vuepress/bundler-vite": "2.0.0-rc.18",
"sass-embedded": "^1.79.5",
"vue": "^3.5.12",
"vuepress": "2.0.0-rc.18",
"vuepress-theme-hope": "2.0.0-rc.59"
}
}
Loading

0 comments on commit 9c7e5a9

Please sign in to comment.