Skip to content

Commit 1d16964

Browse files
committed
Add GitHub Pages deployment workflow and upgrade Docusaurus
- Add GitHub Actions workflow for automated deployment to GitHub Pages - Upgrade Docusaurus from 3.4.0 to 3.9.2 with latest features and bug fixes - Upgrade React from 18.3.1 to 19.2.0 for improved performance - Upgrade MDX and prism-react-renderer dependencies - Add CNAME file for custom domain (www.apexfp.org) - Fix deprecated onBrokenMarkdownLinks config for Docusaurus v4 compatibility The workflow builds and deploys the documentation site automatically on pushes to main branch.
1 parent 5ed4649 commit 1d16964

File tree

5 files changed

+7116
-3605
lines changed

5 files changed

+7116
-3605
lines changed

.github/workflows/website.yml

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

website/docusaurus.config.js

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,12 @@ const config = {
1414
url: 'https://www.apexfp.org',
1515
baseUrl: '/',
1616
onBrokenLinks: 'throw',
17-
onBrokenMarkdownLinks: 'warn',
1817
favicon: 'img/favicon.ico',
18+
markdown: {
19+
hooks: {
20+
onBrokenMarkdownLinks: 'warn',
21+
},
22+
},
1923
organizationName: 'apex-fp', // Usually your GitHub org/user name.
2024
projectName: 'apex-fp', // Usually your repo name.
2125

0 commit comments

Comments
 (0)