How usgpo/innovation works
Project type and purpose
• This is a Jekyll-based, GitHub Pages–hosted static website (“Innovation Hub”) that aggregates and presents legislative-branch technology activities, events, resources, and reports in markdown, PDF, and image formats.
• Its purpose is purely content delivery—no dynamic backend—focusing on collaboration, data standardization, and transparency.
File structure
• Top-level:
• Gemfile/Gemfile.lock, _config.yml → Ruby/Jekyll dependencies & configuration
• _data → YAML data (header, footer)
• _includes → reusable HTML snippets (e.g., hero component)
• _layouts → page templates (e.g., home.html)
• _pages, index.md → standalone markdown pages
• _events → event-specific markdown and PDFs
• assets → CSS (SCSS) and images
• resources, resources/reports → PDFs, PPTs, other assets
• All content and templates feed into Jekyll’s build engine, which compiles markdown + layouts + includes + data into a /_site folder of static HTML/CSS/JS.
README for additional insights
• Confirms iterative, non-partisan development via GitHub/GitHub Pages.
• No mention of external APIs or databases—purely static site.
a. Main components:
1. Developer Workstation
• Source files: markdown, YAML, SCSS, HTML snippets, PDFs
• Gemfile/Ruby environment with Jekyll & plugins
2. Version Control & CI (GitHub repo)
• Push → triggers build in GitHub Pages (or custom Actions)
3. Jekyll Build Engine
• Reads _config.yml, _data, _includes, _layouts, content directories, assets
• Compiles markdown → HTML, SCSS → CSS, inlines includes, injects data
• Produces static site in /_site
4. Hosting Layer (GitHub Pages + CDN)
• Serves /_site contents over HTTPS
5. End Users (Browsers)
• Request pages, CSS, images, PDFs
b. Relationships & data flows:
• Developer → Git push → GitHub repo
• GitHub Pages build (Jekyll) reads source → outputs /_site
• /_site served via GitHub Pages/CDN → Browser requests
• Browser displays static HTML, pulls CSS, images, PDFs
c. Architectural patterns & design principles:
• Static Site Generation (SSG)
• Separation of concerns: content (_pages, _events), presentation (layouts, includes), data (_data), assets (assets/css, assets/img)
• Convention over configuration (Jekyll)
• Asset pipeline: SCSS preprocessing bundled into Jekyll
d. Key technologies/frameworks:
• Ruby + Jekyll
• SCSS (via Jekyll’s Sass plugin)
• Git/GitHub/GitHub Pages
• Markdown, YAML
Summary of essential elements
• Role of Gemfile/Ruby environment.
• Build steps (markdown → HTML, SCSS → CSS).
• Keep it concise but comprehensive: no backend services, no databases—just SSG pipeline.