How kookmin-sw/capstone-2025-05 works
Project type and purpose
• This is a static website (GitHub Pages) powered by Jekyll (or another Markdown‐to‐HTML generator).
• Its purpose is to host a “capstone team” landing page: project intro, team member profiles, usage instructions, and media.
File structure
• Top‐level files:
• _config.yml → Jekyll/GitHub Pages configuration
• index.md → the home page content in Markdown
• README.md → project README (not part of the published site, but for repo instructions)
• There are no backend, API, build scripts, or tests: it’s purely a static content pipeline.
README for additional insights
• The README guides contributors on:
• Editing index.md for project intro
• Customizing the theme via GitHub Pages settings
• Using Markdown (headings, lists, images, links)
• It references GitHub Pages “Source = master” and theme chooser, implying the site build and serve pipeline is handled by GitHub.
a. Developer workstation
– Edits .md and _config.yml locally
– Commits & pushes to GitHub repo
b. GitHub Repository
– Hosts the source files
– Triggers GitHub Pages build
c. Jekyll / Pages Build Engine (on GitHub infra)
– Reads _config.yml + Markdown (.md)
– Applies theme/layouts → generates static HTML/CSS/JS
d. GitHub Pages CDN/Server
– Serves the generated static site at https://<org>.github.io/<repo>
e. End‐user’s Browser
– Requests pages, loads HTML/CSS/JS, renders site
Relationships and data flow
• Developer → (git push) → GitHub Repo
• GitHub Repo → (build trigger) → Pages Build Engine
• Build Engine → (artifact publish) → CDN
• Browser ↔ CDN (HTTP GET/response)
Architectural patterns/design principles
• Static Site Generation (SSG): separation between content (Markdown) and presentation (HTML templates/themes)
• Continuous Deployment: every git push auto‐triggers build & deploy
• CDN distribution for global performance
Relevant technologies/frameworks
• Git & GitHub
• Jekyll (or whichever static site generator GitHub Pages uses)
• Markdown
• GitHub Pages hosting & CDN