Skip to content

Commit 7cfedb0

Browse files
authored
New documentation website
1 parent 946d653 commit 7cfedb0

25 files changed

+15984
-1033
lines changed

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ on:
77
- '!.gitignore'
88
- '!LICENSE'
99
- '!TODO'
10-
- '!doc/**'
10+
- '!docs/**'
1111
- '!examples/**'
1212
- '.github/workflows/ci.yml'
1313
push:

.github/workflows/docs.yml

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: Docs
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
paths:
8+
- 'docs/**'
9+
- '.github/workflows/*docs.yml'
10+
11+
jobs:
12+
build:
13+
name: Build Docusaurus
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: actions/checkout@v4
17+
- uses: actions/setup-node@v4
18+
with:
19+
node-version-file: 'docs/.nvmrc'
20+
- name: Install dependencies
21+
working-directory: ./docs
22+
run: npm install
23+
- name: Build
24+
working-directory: ./docs
25+
run: npm run build
26+
- name: Upload Build Artifact
27+
uses: actions/upload-pages-artifact@v3
28+
with:
29+
path: docs/build
30+
31+
deploy:
32+
name: Deploy to GitHub Pages
33+
needs: build
34+
35+
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
36+
permissions:
37+
pages: write # to deploy to Pages
38+
id-token: write # to verify the deployment originates from an appropriate source
39+
40+
# Deploy to the github-pages environment
41+
environment:
42+
name: github-pages
43+
url: ${{ steps.deployment.outputs.page_url }}
44+
45+
runs-on: ubuntu-latest
46+
steps:
47+
- name: Deploy to GitHub Pages
48+
id: deployment
49+
uses: actions/deploy-pages@v4

.github/workflows/test-docs.yml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: Test Docs
2+
3+
on:
4+
pull_request:
5+
paths:
6+
- 'docs/**'
7+
- '.github/workflows/*docs.yml'
8+
9+
jobs:
10+
test-docs:
11+
name: Test Docusaurus build
12+
runs-on: ubuntu-latest
13+
steps:
14+
- uses: actions/checkout@v4
15+
- uses: actions/setup-node@v4
16+
with:
17+
node-version-file: 'docs/.nvmrc'
18+
- name: Install dependencies
19+
working-directory: ./docs
20+
run: npm install
21+
- name: Build
22+
working-directory: ./docs
23+
run: npm run build

0 commit comments

Comments
 (0)