Skip to content

Commit 2b5e420

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 2b5e420

71 files changed

Lines changed: 12989 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: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
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+
cache-dependency-path: website/pnpm-lock.yaml
30+
node-version: 20
31+
cache: pnpm
32+
33+
- name: Install dependencies
34+
run: pnpm i
35+
- name: Build website
36+
run: pnpm run build
37+
38+
- name: Upload Build Artifact
39+
uses: actions/upload-pages-artifact@v3
40+
with:
41+
path: build
42+
43+
deploy:
44+
name: Deploy to GitHub Pages
45+
needs: build
46+
47+
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
48+
permissions:
49+
pages: write # to deploy to Pages
50+
id-token: write # to verify the deployment originates from an appropriate source
51+
52+
# Deploy to the github-pages environment
53+
environment:
54+
name: github-pages
55+
url: ${{ steps.deployment.outputs.page_url }}
56+
57+
runs-on: ubuntu-latest
58+
steps:
59+
- name: Deploy to GitHub Pages
60+
id: deployment
61+
uses: actions/deploy-pages@v4
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
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+
cache-dependency-path: website/pnpm-lock.yaml
28+
node-version: 20
29+
cache: npm
30+
31+
- name: Install dependencies
32+
run: npm ci
33+
- name: Test build website
34+
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)