Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 14 additions & 23 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,20 @@ on:
- main

jobs:
build:
name: Build Docusaurus
deploy:
name: Deploy to GitHub Pages
runs-on: ubuntu-latest
permissions:
contents: write
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
steps:
- uses: actions/checkout@v6
- uses: actions/checkout@v4
with:
# Docusaurus needs the full commit history to correctly
# determine the last update time and author.
fetch-depth: 0
- uses: actions/setup-node@v6
- uses: actions/setup-node@v4
with:
node-version-file: package.json
cache: npm
Expand All @@ -25,24 +29,11 @@ jobs:
- name: Build website
run: npm run build

- name: Upload Build Artifact
uses: actions/upload-pages-artifact@v3
# Popular action to deploy to GitHub Pages:
# Docs: https://github.com/peaceiris/actions-gh-pages
- name: Deploy website
uses: peaceiris/actions-gh-pages@v4
with:
path: build
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./build

deploy:
name: Deploy to GitHub Pages
needs: build
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
5 changes: 3 additions & 2 deletions .github/workflows/test-deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ jobs:
name: Test deployment
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- uses: actions/setup-node@v6
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version-file: package.json
cache: npm
Expand All @@ -21,3 +21,4 @@ jobs:
run: npm ci
- name: Test build website
run: npm run build

9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,14 +34,13 @@ can be served using any static contents hosting service.
### Deployment

This website is configured for deployment to [GitHub
Pages][github-pages]. [GitHub Actions][github-actions] build and
publish it on pushes to `main` using GitHub's official Pages actions:
[upload-pages-artifact] and [deploy-pages].
Pages][github-pages]. The deployment is triggered with [GitHub
Actions][github-actions]; it uses a popular third-party deployment
action:
[peaceiris/actions-gh-pages](https://github.com/peaceiris/actions-gh-pages).

[github-pages]: https://pages.github.com/
[github-actions]: https://help.github.com/actions
[upload-pages-artifact]: https://github.com/actions/upload-pages-artifact
[deploy-pages]: https://github.com/actions/deploy-pages

### License

Expand Down
7 changes: 1 addition & 6 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -55,12 +55,7 @@ const config = {
trailingSlash: false,

onBrokenLinks: 'throw',

markdown: {
hooks: {
onBrokenMarkdownLinks: 'warn',
},
},
onBrokenMarkdownLinks: 'warn',

i18n: {
defaultLocale: 'en',
Expand Down
Loading
Loading