This directory is a self-contained Jekyll site for the CPEN 221A team project.
The published guide is in index.md, and its supporting notes are in notes.md.
The imported description is retained in source/project-description.md. The
guide is generated from that source, while the notes page is a curated adaptation
that can be edited directly. Run python3 scripts/import_project.py after updating
the imported description; the script regenerates index.md only.
The site shares the course syllabus's institutional visual system and self-hosted font assets. Readers can choose IBM Plex Serif with IBM Plex Sans and IBM Plex Mono, or Google Sans Flex with Google Sans Code. The choice is retained in the browser and shared with the CPEN 221 readings and syllabus sites.
Use Ruby 3.3 and run:
bundle install
bundle exec jekyll serve --livereloadRun the validation checks after changing the content or layout:
python3 scripts/check_site.pyThis site is configured for https://cpen-221.github.io/project/. If the GitHub
repository uses a different name, update baseurl in _config.yml to match it.
In the repository settings, open Pages and choose Deploy from a branch.
Select the main branch and the /(root) folder. GitHub Pages will run Jekyll and
publish the site after each push. No GitHub Actions workflow is needed.