Skip to content

Commit f52fc5d

Browse files
committed
feat: init docs
0 parents  commit f52fc5d

File tree

146 files changed

+25510
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

146 files changed

+25510
-0
lines changed

.github/workflows/deploy-docs.yml

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: Deply docs
2+
3+
on:
4+
push:
5+
branches:
6+
# 确保这是你正在使用的分支名称
7+
- main
8+
9+
jobs:
10+
deploy-gh-pages:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- name: Checkout
14+
uses: actions/checkout@v3
15+
with:
16+
fetch-depth: 0
17+
# 如果你文档需要 Git 子模块,取消注释下一行
18+
# submodules: true
19+
20+
- name: Install pnpm
21+
uses: pnpm/action-setup@v2
22+
with:
23+
version: 7
24+
run_install: true
25+
26+
- name: Setup Node.js
27+
uses: actions/setup-node@v3
28+
with:
29+
node-version: 18
30+
cache: pnpm
31+
32+
- name: Build docs
33+
env:
34+
NODE_OPTIONS: --max_old_space_size=4096
35+
run: |-
36+
pnpm run docs:build
37+
> src/.vuepress/dist/.nojekyll
38+
39+
- name: 部署文档
40+
uses: JamesIves/github-pages-deploy-action@v4
41+
with:
42+
# 这是文档部署到的分支名称
43+
branch: gh-pages
44+
folder: src/.vuepress/dist

.gitignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
2+
node_modules/
3+
src/.vuepress/.cache/
4+
src/.vuepress/.temp/
5+
src/.vuepress/dist/

.prettierignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
pnpm-lock.yaml

package.json

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
{
2+
"name": "vuepress-docs",
3+
"version": "2.0.0",
4+
"description": "VuePress v2 docs",
5+
"license": "MIT",
6+
"type": "module",
7+
"packageManager": "[email protected]",
8+
"scripts": {
9+
"docs:build": "vuepress build src",
10+
"docs:clean-dev": "vuepress dev src --clean-cache",
11+
"docs:dev": "vuepress dev src",
12+
"docs:update-package": "pnpm dlx vp-update",
13+
"docs:lint": "prettier --check --write ."
14+
},
15+
"devDependencies": {
16+
"@vuepress/client": "2.0.0-beta.60",
17+
"@vuepress/plugin-docsearch": "2.0.0-beta.60",
18+
"@vuepress/utils": "2.0.0-beta.60",
19+
"prettier": "2.8.4",
20+
"vue": "^3.2.47",
21+
"vuepress": "2.0.0-beta.60",
22+
"vuepress-theme-hope": "2.0.0-beta.179"
23+
}
24+
}

0 commit comments

Comments
 (0)