Skip to content

Commit 6ae6d38

Browse files
Default docusaurus site. Add github workflows for deployment of documentation to github pages on push. Restructure project. Nice monorepo.
1 parent 9314e81 commit 6ae6d38

71 files changed

Lines changed: 12987 additions & 0 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
name: Deploy documentation site to GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
workflow_dispatch:
8+
9+
10+
defaults:
11+
run:
12+
working-directory: website
13+
14+
jobs:
15+
build:
16+
name: Build Docusaurus
17+
runs-on: ubuntu-latest
18+
steps:
19+
- uses: actions/checkout@v4
20+
with:
21+
fetch-depth: 0
22+
- uses: pnpm/action-setup@v4
23+
name: Install pnpm
24+
with:
25+
version: 10
26+
run_install: false
27+
- uses: actions/setup-node@v4
28+
with:
29+
node-version: 20
30+
cache: pnpm
31+
32+
- name: Install dependencies
33+
run: pnpm i
34+
- name: Build website
35+
run: pnpm run build
36+
37+
- name: Upload Build Artifact
38+
uses: actions/upload-pages-artifact@v3
39+
with:
40+
path: build
41+
42+
deploy:
43+
name: Deploy to GitHub Pages
44+
needs: build
45+
46+
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
47+
permissions:
48+
pages: write # to deploy to Pages
49+
id-token: write # to verify the deployment originates from an appropriate source
50+
51+
# Deploy to the github-pages environment
52+
environment:
53+
name: github-pages
54+
url: ${{ steps.deployment.outputs.page_url }}
55+
56+
runs-on: ubuntu-latest
57+
steps:
58+
- name: Deploy to GitHub Pages
59+
id: deployment
60+
uses: actions/deploy-pages@v4
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: Test documentation site deployment
2+
3+
on:
4+
pull_request:
5+
branches:
6+
- main
7+
8+
defaults:
9+
run:
10+
working-directory: ./website
11+
12+
jobs:
13+
test-deploy:
14+
name: Test deployment
15+
runs-on: ubuntu-latest
16+
steps:
17+
- uses: actions/checkout@v4
18+
with:
19+
fetch-depth: 0
20+
- uses: pnpm/action-setup@v4
21+
name: Install pnpm
22+
with:
23+
version: 10
24+
run_install: false
25+
- uses: actions/setup-node@v4
26+
with:
27+
node-version: 20
28+
cache: npm
29+
30+
- name: Install dependencies
31+
run: npm ci
32+
- name: Test build website
33+
run: npm run build
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)