Skip to content

Add GitHub Pages workflow to build and publish Typst write-up PDF - #2

Merged
NimVrod merged 2 commits into
mainfrom
copilot/host-pdf-writeup
Jun 6, 2026
Merged

NimVrod merged 2 commits into
mainfrom
copilot/host-pdf-writeup

Conversation

Copilot AI commented Jun 6, 2026 •

Copy link
Copy Markdown
Contributor

This issue asks to host the project write-up on GitHub Pages and automatically compile the Typst source on each commit. This PR adds a dedicated Actions workflow to build the PDF and publish it as a Pages site artifact.

  • Workflow: build + deploy write-up

    • Added .github/workflows/writeup-pages.yml.
    • Triggers on push, pull_request, and workflow_dispatch.
    • Uses typst-community/setup-typst@v4 to compile WriteUp/main.typ into site/main.pdf.
  • Pages artifact and deployment

    • Uploads site/ via actions/upload-pages-artifact@v3.
    • Deploys with actions/deploy-pages@v4 on pushes to the repository default branch.
    • Includes required Pages permissions (pages: write, id-token: write) and a Pages-safe concurrency group.
  • Hosted entrypoint

    • Generates site/index.html during the workflow.
    • Serves an embedded PDF viewer with a direct fallback link to main.pdf.
- name: Build PDF
  run: |
    mkdir -p site
    typst compile --root . WriteUp/main.typ site/main.pdf

- name: Upload pages artifact
  uses: actions/upload-pages-artifact@v3
  with:
    path: site

Copilot AI linked an issue Jun 6, 2026 that may be closed by this pull request
Copilot AI changed the title [WIP] Host the PDF writeup using GitHub Pages Add GitHub Pages workflow to build and publish Typst write-up PDF Jun 6, 2026
Copilot AI requested a review from NimVrod June 6, 2026 10:16
@NimVrod
NimVrod marked this pull request as ready for review June 6, 2026 10:17
@NimVrod
NimVrod merged commit d741371 into main Jun 6, 2026
2 of 4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Host the pdf writeup

2 participants