How thepkuhub/pkuhub_developer_tutorial works
Project type and purpose
• This is a monorepo holding several “PKUHUB Developer Tutorial” slide‐deck projects plus code examples and notes.
• It is not a web application or a runtime service. Instead, it’s a documentation/slide‐generation system with three different slide engines (Typst, Vue/Vite, Vue/Netlify) plus a Rust code‐example crate and some raw notes.
File structure
• Top‐level:
• lecture1-3-4-6/ – A Typst‐based slide deck
• lecture2/ – A Vite + Vue slide deck
• lecture5/ – A pnpm/Vue slide deck with Netlify/Vercel configs
• rust-examples/ – A Cargo project with example .rs files
• speech_notes/ – Raw notes in Typst and Markdown
• readme.md – Monorepo overview
• Each slide‐deck directory contains its own source files, configuration, dependencies, and build scripts.
• There are no direct runtime dependencies between directories—they are loosely grouped artifacts built and deployed independently.
README for additional insights
• The global README focuses on the Typst deck (lecture1-3-4-6), recommending VSCode plugins (Tinymist Typst, Typst Companion) and showing the template/sections pattern.
• It calls out a four‐file pattern: globals.typ, main.typ, sections/_template.typ, sections/*.typ.
• Monorepo Root
– Contains slide subprojects, code examples, notes
• Slide Deck: Typst Engine (lecture1-3-4-6)
– Inputs: globals.typ, main.typ, sections/*.typ, images
– Tool: Typst CLI / VSCode Plugins
– Output: PDF slides
• Slide Deck: Vue/Vite Engine (lecture2)
– Inputs: components/*.vue, layouts/*.vue, slides.config.ts, style.css
– Tool: Vite + Vue, NPM
– Output: Static HTML/CSS/JS site
• Slide Deck: pnpm/Vue + Hosting (lecture5)
– Inputs: components/*.vue, slides.md, style.css, netlify.toml, vercel.json
– Tool: pnpm workspace, Vue, Netlify CLI, Vercel CLI
– Output: Hosted site on Netlify/Vercel
• Rust Examples (rust-examples)
– Inputs: Cargo.toml, src/*.rs
– Tool: cargo build / run
– Output: Command‐line executable or library
• Speech Notes (speech_notes)
– Inputs: .typ, .md files
– Tool: VSCode / Typst / Markdown viewer
– Output: Notes for speakers
• Root → Each subproject (structure containment)
• Each subproject → Its build tool (Typst CLI, Vite, pnpm, cargo)
• Build tool → Output artifact (PDF or static site or binary)
c. Architectural patterns / design principles:
• Monorepo pattern: co-located independent modules
• Polyglot tooling: different slide engines side by side
• Source→Build→Artifact pipeline per module
• Clear separation of concerns: slide content vs. build config vs. deployment config
d. Key technologies and frameworks:
• Typst (Typst CLI, Tinymist Typst, Typst Companion)
• Node.js / pnpm / NPM / Vite / Vue 3
• Netlify & Vercel for hosting
• Rust & Cargo for examples
• Markdown for raw notes
Elements
• Blue for source files/modules
• Green for build tools
• Orange for outputs/artifacts
• Purple for external services (Netlify, Vercel)