How munuchapterhkn/eta-kappa-notes works
Project type and purpose
• Eta Kappa Notes is neither a web application nor a microservice-based system. It is a static‐content generation pipeline for academic notes, supporting two document composition engines (LaTeX and Typst) plus Python‐driven figure generation. The goal is to standardize and automate the production of high-quality PDFs (and related assets) from source notes and templates.
File structure
• Top-level directories:
• notes/ – course material in .tex (.latex) plus resource subfolders
• guide/ – tutorial and starter docs split into guide/latex/ and guide/typst/
• lib/ – shared templates (LaTeX .cls/.tex, Typst .typ) and build configurations
• Key files:
• pyproject.toml & requirements.txt – Python scripts dependencies
• typst.toml – Typst configuration
• .vscode/settings.json (implied) & latexmkrc – build tool settings
• Patterns:
• “content + template → compiler → output” for both LaTeX and Typst
• Python scripts in guide/latex/res/py generate figures used in notes and guide
README for additional insights
• Supported backends: LaTeX (via latexmk, TeX Live, Inkscape) and Typst (v0.12+)
• Python environment for programmatic figures
• Contribution workflow revolves around editing source notes/templates and rebuilding
a. Main components
1) Content Repositories:
– notes/ (course .tex + assets)
– guide/ (tutorial source in .tex and .typ, plus embedded Python scripts)
2) Template Library:
– lib/latex (HKNdocument.cls, preamble/postamble, latexmkrc)
– lib/typst (funcs.typ, template.typ, typst.toml)
3) Build Engines:
– LaTeX Engine (latexmk → pdflatex/xelatex + Inkscape)
– Typst Compiler
– Python Runner (virtualenv, scripts in guide/latex/res/py)
4) Shared Resources:
– resources/imgs (logos, ideogram)
5) Outputs:
– PDF artifacts: notes PDFs, guide.pdf
6) Developers’ Tools:
– VS Code + LaTeX Workshop extension
– CI pipeline (optional)
b. Relationships and data flows
– Content Repositories and Template Library feed into Build Engines.
– Python Runner may generate intermediate assets (SVGs, PDFs) placed into resources or directly referenced.
– Build Engines consume both content and templates, invoking external tools (Inkscape) as needed.
– Outputs are deposited in the file tree alongside source or into designated output folders.
c. Architectural patterns & design principles
– Pipeline pattern (“read sources → transform → write outputs”)
– Configuration-as-code for build tools (latexmkrc, typst.toml)
– Separation of concerns: content vs. presentation (templates) vs. tooling
– Reproducibility: versioned tool versions, virtual environments
d. Key technologies & frameworks
– LaTeX (TeX Live distribution, latexmk, Inkscape for SVG→PDF)
– Typst (v0.12+, typst.toml)
– Python 3.x + pip dependencies (requirements.txt)
– VS Code + LaTeX Workshop for local builds
• Blue for source directories (notes/, guide/)
• Green for template libraries (lib/)
• Orange for build engines (LaTeX, Typst, Python)
• Gray for external tools (Inkscape, virtualenv)
• Purple for outputs (PDFs, images)