Skip to content

Commit

Permalink
init the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
NatsumiXD committed Aug 28, 2024
1 parent 0e9e6b2 commit 5b43331
Show file tree
Hide file tree
Showing 44 changed files with 3,997 additions and 1 deletion.
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/
1 change: 0 additions & 1 deletion README.md

This file was deleted.

19 changes: 19 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"name": "better-minecraft-help-docs",
"description": "A Minecraft help docs",
"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.14",
"vue": "^3.4.31",
"vuepress": "2.0.0-rc.14",
"vuepress-theme-hope": "2.0.0-rc.52"
}
}
Loading

0 comments on commit 5b43331

Please sign in to comment.