slidemage-website
The SlideMage website, built with MkDocs Material and
served by GitHub Pages. Every push to main deploys it (.github/workflows/deploy.yml).
Preview locally:
pip install -r requirements.txt
mkdocs serve
Content is in docs/. The paths /plugins/ and /plugins/<id>/ are opened by the SlideMage app; keep them
stable.
Plugin catalogue
SlideMage reads /plugins/index.json; /plugins/index-test.json adds the hidden test plugins.
registry/plugins.toml: the approved plugins. Adding an entry, by a reviewed pull request, is the approval.tools/build_catalogue.py: builds both catalogues from the plugins' GitHub releases, pins every published
asset's SHA-256 in catalogue/pins.json and copies the icons. Validated against
schema/plugins-index.schema.json, which the deploy publishes at its $id
(https://slidemage.org/schema/plugins-index-1.json).tools/plugin_pages.py: the listed plugins' pages (docs/plugins/<id>/index.md) and the cards between the
markers on docs/plugins/index.md, from each plugin's README, CHANGELOG and website/screenshots/ at its
newest release. Plugin texts are defused first: raw HTML and attribute lists are escaped, unsafe links
removed, images reduced to their alt text. Generated files are overwritten; don't edit them by hand.docs/plugins/submit.md (/plugins/submit/): the conventions and the review for plugin authors, with
the pull request template (.github/pull_request_template.md) and the "Submit a plugin" issue form
(.github/ISSUE_TEMPLATE/submit-plugin.yml). The id submit is reserved for it..github/workflows/build-catalogue.yml: runs the builder hourly (and on "Run workflow"), commits and deploys
when something changed, opens an issue when a published asset changes, and keeps the schedule alive with a
monthly heartbeat (catalogue/last-run.txt). On pull requests it runs the tests and builds against the
proposed registry without publishing.
Run it locally with pip install -r requirements-catalogue.txt and python tools/build_catalogue.py --check;
tests with pytest tests.
Content is licensed under CC BY-SA 4.0 (LICENSE).
