How phumal/basic-typst-resume-template works
Project type and purpose
• This is an open-source Typst “resume template” package.
• Purpose: provide a reusable, ATS-friendly resume layout, complete with formatting helpers and example files.
File structure
• Top-level concerns:
• .github/workflows – continuous integration (tests.yml) and release (release.yml)
• scripts/ & Justfile – local setup, packaging, and uninstall automation
• src/ – core Typst library (lib.typ) and resume entrypoint (resume.typ)
• template/ – main.typ example or fallback template
• docs/ – user manual (manual.typ)
• tests/ – test fixtures and reference outputs
• typst.toml – package metadata (name, version, dependencies)
• Patterns: clear separation of source, tests, docs, automation, and CI.
README for additional insights
• Describes how to import the published package (@preview/basic-resume:0.2.8)
• Lists formatting helper functions (#edu, #work, etc.)
• Shows a sample workflow: author sets variables, calls #show: resume.with(...)
Main components
a. Developer workstation
• Typst compiler (external tool)
• Local scripts/Just – setup, package, test commands
• Source modules (src/, template/)
• Tests (tests/)
• Docs (docs/)
b. Version control & CI/CD
• GitHub repo with workflows for test and release
• GitHub Actions runners (execute Justfile targets, run Typst tests)
c. Package registry & consumers
• Typst Package Registry (preview)
• End-user Typst projects (importing the resume template)
Relationships & dataflow
• Developer edits src/, template/, docs/ → commits to GitHub
• GitHub Actions “tests.yml” pulls repo → runs just test → Typst compiles test.typ → compares against tests/debug/ref
• On tag creation, “release.yml” builds package via just package → publishes to Typst registry
• Users import the published version in their .typ files → Typst compiler fetches package → generates PDF
Architectural patterns & design principles
• Separation of concerns: code, docs, tests, automation, CI
• Convention-over-configuration: typst.toml drives package metadata, Justfile centralizes commands
• Source as library + entrypoint (lib.typ + resume.typ)
• Test-driven delivery: fixtures in tests/, CI gating merges
Relevant technologies, frameworks, libraries
• Typst (compiler and package registry)
• Just (task runner)
• Bash scripts (scripts/)
• GitHub Actions (CI/CD)
Detail
• Tests/debug vs. tests/debug/ref comparison in CI
• Typst.toml driving the package metadata block