How pclubiitk/pclub-website works
Project type and purpose
• This is a Jekyll-based static site (a blog/documentation website) with a custom theme.
• The repository holds content (Markdown posts/pages), theme templates (layouts, includes, Sass), assets (images, JS), build scripts, and GitHub Actions workflows for CI/CD.
Main components
a. Content layer
• _posts/, _pages/, _includes/, _layouts/ – Markdown and HTML templates with YAML front matter
• _sass/ – SCSS modules and settings for styling
• js/ and images/ – client-side assets
b. Build pipeline
• Bundler + Gemfile – Ruby dependency manager
• Jekyll engine – static site generator
• Custom updating-scripts – Python script (CSV→YAML) under updating-scripts/ for automating content updates
c. CI/CD
• .github/workflows/jekyll.yml – GitHub Actions that install Ruby, bundle install, run jekyll build, and deploy to GitHub Pages
d. Hosting
• GitHub Pages – serves the generated static HTML/CSS/JS
e. Developer environment
• Local machine with Ruby, gem, bundle; developer runs bundle exec jekyll serve with or without livereload
Relationships and data flow
• Developer → clones repo → runs bundle exec jekyll serve → Bundler installs gems → Jekyll reads content/templates → compiles HTML/CSS/JS → serves at localhost:4000
• On git push → GitHub Actions triggers → installs Ruby + bundle → runs Jekyll build → outputs _site/ → deploys to GitHub Pages → Site goes live
• Optional: updating-scripts take CSV inputs → generate YAML data → gets picked up by Jekyll during build
Architectural patterns and design principles
• Static Site Generation (SSG): separation of content, templates, and build logic
• Convention over configuration: Jekyll folder layout drives routing and page generation
• CI/CD pipeline automates build & deploy on push
• Modular styling with SCSS partials
Detailed elements
• Dependency graph: Gemfile → Jekyll, Sass → CSS