Deployment

You can easily deploy your website to GitHub Pages using GitHub Actions.

GitHub Actions

Create a file named .github/workflows/deploy.yml in your repository with the following content:

name: Deploy

on:
  push:
    branches: [ main ]
  workflow_dispatch:

permissions:
  contents: read
  pages: write
  id-token: write

jobs:
  # Build the site
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v5
      - uses: typst-community/setup-typst@v4
      - run: make html
      - uses: actions/configure-pages@v4
      - uses: actions/upload-pages-artifact@v4
        with:
          path: _site

  # Publish to GitHub Pages
  deploy:
    runs-on: ubuntu-latest
    needs: build
    permissions:
      pages: write
      id-token: write
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - uses: actions/deploy-pages@v4
        id: deployment

Enable GitHub Pages

1. Go to your repository on GitHub.
2. Navigate to Settings, then Pages.
3. Under Build and deployment, select GitHub Actions as the source.

Now, every time you push to the main branch, your website will be automatically built and deployed.