Skip to content

Commit 04d7624

Browse files
committed
chore: add GitHub Actions workflow for deploying to GitHub Pages and update README with build instructions
1 parent 0ca113f commit 04d7624

File tree

2 files changed

+142
-0
lines changed

2 files changed

+142
-0
lines changed

.github/workflows/deploy.yml

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
name: Deploy to GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
paths:
8+
- 'website/**'
9+
- '.github/workflows/deploy.yml'
10+
workflow_dispatch:
11+
12+
permissions:
13+
contents: read
14+
pages: write
15+
id-token: write
16+
17+
concurrency:
18+
group: "pages"
19+
cancel-in-progress: false
20+
21+
jobs:
22+
build:
23+
runs-on: ubuntu-latest
24+
defaults:
25+
run:
26+
working-directory: website
27+
steps:
28+
- name: Checkout
29+
uses: actions/checkout@v4
30+
31+
- name: Setup Node.js
32+
uses: actions/setup-node@v4
33+
with:
34+
node-version: 20
35+
cache: npm
36+
cache-dependency-path: website/package-lock.json
37+
38+
- name: Install dependencies
39+
run: npm ci
40+
41+
- name: Build website
42+
run: npm run build
43+
44+
- name: Upload artifact
45+
uses: actions/upload-pages-artifact@v3
46+
with:
47+
path: website/build
48+
49+
deploy:
50+
environment:
51+
name: github-pages
52+
url: ${{ steps.deployment.outputs.page_url }}
53+
runs-on: ubuntu-latest
54+
needs: build
55+
steps:
56+
- name: Deploy to GitHub Pages
57+
id: deployment
58+
uses: actions/deploy-pages@v4

README.md

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
git submodule init
2+
git submodule update
3+
4+
### Build Errors
5+
6+
If you encounter build errors:
7+
8+
```bash
9+
npm run clear # Clear Docusaurus cache
10+
npm install # Reinstall dependencies
11+
npm run build # Try building again
12+
```
13+
14+
15+
## 🚀 Quick Start
16+
17+
### Prerequisites
18+
19+
- Node.js 20 or higher
20+
- npm (comes with Node.js)
21+
22+
### Installation
23+
24+
```bash
25+
npm install
26+
```
27+
28+
### Local Development
29+
30+
```bash
31+
npm start
32+
```
33+
34+
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
35+
36+
### Build
37+
38+
```bash
39+
npm run build
40+
```
41+
42+
43+
44+
# Website
45+
46+
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
47+
48+
## Installation
49+
50+
```bash
51+
yarn
52+
```
53+
54+
## Local Development
55+
56+
```bash
57+
yarn start
58+
```
59+
60+
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
61+
62+
## Build
63+
64+
```bash
65+
yarn build
66+
```
67+
68+
This command generates static content into the `build` directory and can be served using any static contents hosting service.
69+
70+
## Deployment
71+
72+
Using SSH:
73+
74+
```bash
75+
USE_SSH=true yarn deploy
76+
```
77+
78+
Not using SSH:
79+
80+
```bash
81+
GIT_USER=<Your GitHub username> yarn deploy
82+
```
83+
84+
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

0 commit comments

Comments
 (0)