How bcdigschol/edi-technology works
Main Components
• Static Site Generator: Jekyll is the core engine that processes the content (in _pages, _layouts, and _includes) and configuration (_config.yml) to produce static HTML.
• Frontend Assets: The assets directory (with CSS, JS, images, and fonts) and configuration files such as tailwind.config.js and postcss.config.js show that Tailwind CSS (and further styling) is used for the front-end.
• Local Development Environment: Tools like Ruby (with bundler), Node (with npm dependencies), and the configuration instructions in the README highlight that developers use a dual environment for building and testing the site.
• CI/CD Pipeline: The .github directory (with workflow YAML files) indicates that GitHub Actions are used to build or deploy the site.
• Static Hosting/Deployment: Although not explicitly mentioned, the presence of a Jekyll workflow and hosting-related files (like 404.html) suggests the site might be deployed on GitHub Pages or a similar static hosting service.
Relationships and Interactions
• The Developer / Build Environment interacts with both Ruby (via Bundler) and Node (via npm) to manage dependencies.
• Jekyll takes content from _pages, _layouts, and _includes and combines it with configuration settings (_config.yml) to generate static HTML files.
• The assets (under assets/) are compiled (possibly via a build step with Tailwind and PostCSS) and linked in the templates.
• The GitHub workflows trigger builds and tests (if any), ensuring that changes are checked automatically before deployment.
• The final static output is then deployed/served to users, possibly via GitHub Pages.
Architectural Patterns
• Separation of Concerns: Content (e.g., Markdown files in _pages), Presentation (in _layouts and _includes), and styling (assets/) are clearly separated.
• Build Pipeline: The process moves from local development to automated build and deployment via CI workflows.
Relevant Technologies
• Jekyll (Ruby-based SSG), Ruby (bundler), Node (npm dependencies), Tailwind CSS, PostCSS, and GitHub Actions.
• Mention external tools referenced in the README, such as the TailPages setup by Harry Wang, which indicates that best practices for Jekyll combined with modern CSS frameworks are in place.
Final Advice
• Clarity: Each block should be clearly labeled (for example, “Content & Templates (_pages, _layouts, _includes)”, “Build Engine (Jekyll)”, “Static Assets (assets/, _sass)”, “CI/CD (GitHub Actions)”, and “Deployment (Static Hosting)”).
• External dependency labels (such as Ruby, Node, Tailwind) next to or within their respective build components.