How lucaswithboots/unifal-cc-acervo works
Project Type and Purpose
• This is a static-site documentation portal (“Acervo Ciência da Computação”) built with Jekyll (a Ruby-based static site generator) using the “Just the Docs” template.
• Purpose: host course materials (PDFs, code snippets, markdown docs) on GitHub Pages.
File Structure Analysis
• Top-level config & CI:
• _config.yml – Jekyll settings
• Gemfile / Gemfile.lock – Ruby/Jekyll dependencies
• .github/workflows/ci.yml, jekyll.yml, pages.yml – GitHub Actions pipelines
• .prettierrc / .prettierignore – formatting rules
• Site source:
• index.md – home page
• docs/disciplinas/... – per-course markdown and asset hierarchy
• assets/ – images, CSS, JS (if any)
• _includes/ – HTML snippets for navigation, footer, TOC
• _sass/ – custom SCSS styling
• Deployment artifacts:
• _site/ (generated by Jekyll at build time – not checked in)
README Insights
• Describes tech stack: Jekyll + Just the Docs theme + GitHub Pages.
• Local dev: bundle install → bundle exec jekyll serve.
• Deployment: automated via GitHub Actions → GitHub Pages.
Main Components
a. Developer Environment
• Local machine (Ruby, Bundler, GCC/Make)
• Source files (markdown, assets, configs)
b. Version Control & CI/CD
• GitHub repo
• GitHub Actions workflows:
• Dependabot (dependency updates)
• CI build (runs bundle exec jekyll build)
• Deploy action (pushes _site to gh-pages branch)
c. Build System
• Jekyll Engine + Just the Docs theme plugin
• SCSS compilation (via Jekyll’s Sass converter)
• HTML generation from markdown + includes
d. Hosting & Delivery
• GitHub Pages (serves static files)
• CDN / edge caching (optional via GitHub infrastructure)
e. End Users
• Web browsers requesting pages, assets
Relationships and Data Flow
1. Developer → pushes code to GitHub
2. GitHub repo triggers GitHub Actions workflows
3. CI workflow installs Ruby gems (bundle install)
4. Jekyll build step generates _site (static HTML/CSS/JS)
5. Deploy action commits _site outputs to gh-pages branch
6. GitHub Pages picks up gh-pages branch → hosts static site
7. User browser requests content over HTTPS → delivered by GitHub Pages/CDN
Architectural Patterns & Principles
• Static Site Generation (SSG): pre-render at build time, no runtime backend
• Content–Presentation separation: markdown + templates
• Continuous Integration / Continuous Deployment (CI/CD) pipeline
• Convention over configuration: Jekyll folder conventions (_includes, _sass, docs/)