The entry point to the STAMPED Principles GitHub organization.
This repository serves two purposes:
-
Organization profile. GitHub renders
profile/README.mdon the organization landing page. -
Project website. The same
profile/README.mdis rendered intoindex.htmland published to https://stamped-principles.org via GitHub Pages.
Duplication is evil! A single source (profile/README.md) drives both
the GitHub org page and the public website. To update either, edit
profile/README.md — the Pages workflow
will rebuild and redeploy the site automatically.
pip install markdown
python tools/build_site.py
# then open _site/index.htmlprofile/README.md— single source of truth for the org profile and the website body.tools/build_site.py— Markdown →index.htmlrenderer; also writes aCNAMEand copies any images sitting next to the README..github/workflows/pages.yml— builds and deploys to GitHub Pages on pushes tomainthat touch the profile, the script, or the workflow.