Skip to content

Commit 5dc0b52

Browse files
committed
New Documents
1 parent 7485426 commit 5dc0b52

36 files changed

+896
-447
lines changed

.github/workflows/docs.yml

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
name: docs
2+
3+
on:
4+
# trigger deployment on every push to main branch
5+
push:
6+
branches: [main]
7+
# trigger deployment manually
8+
workflow_dispatch:
9+
10+
jobs:
11+
docs:
12+
runs-on: ubuntu-latest
13+
14+
steps:
15+
- uses: actions/checkout@v2
16+
with:
17+
# fetch all commits to get last updated time or other git log info
18+
fetch-depth: 0
19+
20+
- name: Setup Node.js
21+
uses: actions/setup-node@v1
22+
with:
23+
# choose node.js version to use
24+
node-version: '14'
25+
26+
# cache node_modules
27+
- name: Cache dependencies
28+
uses: actions/cache@v2
29+
id: yarn-cache
30+
with:
31+
path: |
32+
**/node_modules
33+
key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
34+
restore-keys: |
35+
${{ runner.os }}-yarn-
36+
37+
# install dependencies if the cache did not hit
38+
- name: Install dependencies
39+
if: steps.yarn-cache.outputs.cache-hit != 'true'
40+
run: yarn --frozen-lockfile
41+
42+
# run build script
43+
- name: Build VuePress site
44+
run: yarn docs:build
45+
46+
# please check out the docs of the workflow for more details
47+
# @see https://github.com/crazy-max/ghaction-github-pages
48+
- name: Deploy to GitHub Pages
49+
uses: crazy-max/ghaction-github-pages@v2
50+
with:
51+
# deploy to gh-pages branch
52+
target_branch: gh-pages
53+
# deploy the default output dir of VuePress
54+
build_dir: build
55+
env:
56+
# @see https://docs.github.com/en/actions/reference/authentication-in-a-workflow#about-the-github_token-secret
57+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
.DS_Store
22
node_modules
33
/dist
4+
/build
45

56
# local env files
67
.env.local

.npmignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
/resources
22
/docs
3-
/development
43
/public
54
/.github
5+
/build
66

77
/yarn.lock
88
/package-lock.json

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -162,5 +162,5 @@ Then,
162162
```
163163

164164
```bash
165-
yarn serve
165+
yarn docs:dev
166166
```

coverage/coverage-final.json

Lines changed: 3 additions & 3 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy