Source for https://baker-scripts.github.io, the landing site for the baker-scripts organization. It is an MkDocs Material site. Each project page is a copy of that repo's README, refreshed weekly.
pip install mkdocs-material
mkdocs serve # http://127.0.0.1:8000mkdocs build writes site/, which is gitignored.
| File | Purpose |
|---|---|
mkdocs.yml |
Site name, URL, theme (Material, slate, deep purple and amber), extensions, and nav |
docs/index.md |
Home page: hero, project cards, live-app cards |
docs/projects/*.md |
Mirrored project READMEs. Overwritten by the sync job; do not edit by hand. |
docs/stylesheets/extra.css, docs/assets/ |
Styling and images |
scripts/fix-readme-links.sh |
Rewrites mirrored README links that break on this site and adds a "View on GitHub" button |
renovate.json, .coderabbit.yaml |
Dependency updates and review config |
.github/workflows/deploy.yml runs on push to main, workflow_dispatch, and a weekly cron (Monday 06:00 UTC). It has three jobs:
sync-readmesfetches the README ofStarrScripts,Scripts,autodns,docker-compose-debugger,docs-templates,pmm-config,qui_workflows, andRedditModLogthroughgh api, runsscripts/fix-readme-links.sh, and commits any change todocs/projects/aschore: sync READMEs from source repos.buildbuilds the site and uploads the Pages artifact.deploypublishes it to GitHub Pages.
- Add the repo name to the
for repo in ...list in thesync-readmesjob. - Add a nav entry to
mkdocs.ymland a card todocs/index.md. - Run the workflow with
workflow_dispatch.