How shingzhanho/hku-notes works
Project type and purpose
• This is neither a classic frontend/backend web-app nor a microservices system. It’s a static-site generation pipeline for LaTeX-based course notes, managed as an open-source tool with CI/CD.
• Purpose: store LaTeX/Markdown notes in Git, automatically compile them into a static documentation site via GitHub Actions, and publish (e.g., to GitHub Pages).
File structure
• Top-level directories:
• .github/workflows → CI/CD pipeline definitions
• build/ → Python-based build orchestration, metadata extraction utilities (mttools), helper scripts, requirement lists
• src/ → Source content: LaTeX and Markdown for each course
• site/ → Generated static site (mkdocs.yml + docs/ folder)
• Key patterns:
• ETL/pipeline style: source → transform → site output
• Custom Python package (build/mttools) for metadata extraction
• Use of MkDocs (and possibly custom MkDocs Material theme) to convert Markdown into HTML
• CI/CD config (.github/workflows/build-and-deploy.yml) triggers build/ scripts and publishes site/ output.
README for additional insights
• Confirms: personal revision resource manager, compilation + distribution online via GitHub Actions.