How machuangtao/llm-kg4qa works
Project type and purpose
• This is a static documentation website (a survey and tutorial) built with a static site generator (Jekyll) and hosted via GitHub Pages.
• The README contains the survey content (“LLM-KG4QA”), and the two directories (survey-emnlp25 and tutorial-edbt25) correspond to two separate pages: an HTML page for the EMNLP 2025 survey and a Markdown-based tutorial for EDBT 2025.
File structure
• Top-level:
• LICENSE, README.md – repository metadata and main content index.
• _config.yaml – Jekyll configuration file indicating site settings.
• survey-emnlp25/ – pre-built HTML page plus static assets (CSS, JS, images).
• tutorial-edbt25/ – Markdown source (index.md) for the tutorial page.
• Jekyll pattern: configuration, content (Markdown/HTML), static assets, build outputs.
• No dynamic backend or database—purely static.
Insights from README
• No runtime components—this is a content repository.
• The site is meant to present a taxonomy of papers, with links and sections—typical of a static documentation site.
a. Main components
• Content Source
– Markdown files (tutorial-edbt25/index.md, README.md)
– HTML files (survey-emnlp25/index.html)
– Static assets (CSS, JS, images)
• Build Engine
– Jekyll (Ruby) that reads _config.yaml and content sources
– Produces a static site
• Repository & CI/CD
– GitHub repository (source control)
– GitHub Pages (build trigger or Actions workflow)
• Hosting & Delivery
– GitHub Pages CDN (serves the built static files)
• Client
– Web browser (user) fetching HTML, CSS, JS from CDN
b. Relationships and interactions
1. Developer pushes commits (content + config) → GitHub repo
2. GitHub Pages/Actions triggers Jekyll build
3. Jekyll reads Markdown/HTML + _config.yaml + assets → generates static site
4. Build outputs deployed to GitHub Pages CDN
5. User’s browser requests pages → CDN returns HTML and static assets
c. Architectural patterns/design principles
• Static site generation (SSG): content-in, static-out approach
• Separation of concerns:
• Content layer (Markdown, HTML)
• Presentation layer (CSS, JS)
• Build layer (Jekyll)
• Delivery layer (CDN)
• CDN for performance and global distribution
d. Key technologies/frameworks
• Jekyll (Ruby) for site generation
• GitHub Pages for hosting
• Bulma CSS framework (in static/css/bulma.css)
• Custom JavaScript (bulma-carousel.js, bulma-slider.js, index.js)
Be detailed but focused
• Logical component (content repo, build engine, hosting layer, client).
• Don’t over-break the system into microservices—this is a simple SSG pipeline.
[Developer]
│ git push
▼
[GitHub Repo ── contains ──> survey-emnlp25/, tutorial-edbt25/, _config.yaml]
│ build trigger (GitHub Pages / Action)
▼
[Jekyll Build Engine]
│ processes Markdown + HTML + assets
▼
[Generated Static Site]
│ deploy
▼
[GitHub Pages CDN]
│ HTTP GET
▼
[User Browser]