How jerry050512/typst-notes works
Project type and purpose
• This is a “documentation repository” of course notes written in Typst, with an automated CI/CD pipeline that compiles .typ files into PDF and publishes them to GitHub Releases.
• Key purpose: maintain, compile, and distribute PDF versions of notes for multiple courses.
File structure
• Top-level directories for each course:
• Circuits-and-Electronics
• Control-Engineering
• Microcomputer
• Pattern-Recoginition-and-Machine-Learning
• Signals-and-Systems
• Each course folder contains:
• note.typ (lecture notes)
• practice.typ (practice exercises)
• an assets/ subfolder for images or supplementary files
• Repository-level:
• .github/workflows/compile-and-release.yml – GitHub Actions workflow definition
• WORKFLOW.md – detailed workflow documentation
• test-workflow.sh – helper script for scanning and building
• template/ – shared Typst templates and configurations
• README.md – project overview, installation, and usage instructions
README for additional insights
• Explains how to compile manually with typst compile input.typ [output.pdf]
• Describes automated workflow:
• Automatically finds all note.typ and practice.typ files
• Names PDFs as {directory}-{filetype}.pdf
• Publishes to GitHub Releases on pushes to main or tagged commits
• Mentions external dependency: the Typst compiler and required Chinese fonts
Main components and interactions (
a. Components
1. Developer workstation (local environment)
2. GitHub repository (source of truth)
3. CI/CD pipeline – GitHub Actions runner
4. Build script (test-workflow.sh)
5. Typst compiler (installed on runner)
6. Source directories (per-course .typ files + assets)
7. Shared Typst template (template/)
8. Artifact store – GitHub Releases (PDF outputs)
9. Users (downloaders of PDFs)
b. Relationships / Data flow
• Developer commits .typ files → pushes to GitHub
• Push triggers GitHub Actions workflow
• Runner executes compile-and-release.yml → calls test-workflow.sh
• Script scans each course folder for .typ files and invokes Typst compiler with the template
• Generates PDFs named by {course}-{note/practice}.pdf
• Uploads artifacts to GitHub Releases (draft or new version depending on tag)
• Users retrieve compiled PDFs from Releases
c. Architectural patterns
• CI/CD pipeline (automation)
• Convention-over-configuration: folder naming and file patterns drive script logic
• Single repository for both source and deployment artifacts (via GitHub Releases)
d. Key technologies
• Typst (document compiler)
• GitHub Actions (CI/CD)
• Bash (shell script)
• GitHub Releases (artifact hosting)