Repository navigation
feat: slides inside the docs site + GitHub Pages deploy - #2
Merged
Merged
Conversation
- packages.slides inlines each data-markdown deck into its .html (flake-parts/scripts/inline-markdown.py): the built deck opens from file:// and carries no .md for MkDocs to render - documentation build copies the built deck to /slides/ (mkdocs-preBuildHook); new Presentation page embeds it in an iframe - .github/workflows/pages.yml: nix flake check + nix build .#documentation, deploy to GitHub Pages on main (PRs check and build only) - docs updated for all of the above Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0134mfNgkokU4oenUnqXigQz
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Requested by Andrew · project thread
Before: the docs site and the slide deck are two unrelated builds, and nothing publishes them.
After:
nix build .#documentationalso contains the built deck at/slides/, and a new Presentation page embeds it. The deck still builds on its own withnix build .#slides, and the builtindex.htmlnow also opens straight from disk. A GitHub Actions workflow runsnix flake check, builds the site and deploys it to GitHub Pages on every push tomain. Pull requests run the check and the build without deploying.Pages has to be enabled once: Settings → Pages → Source: GitHub Actions.
How:
packages.slidesfolds eachdata-markdown="x.md"deck into its HTML as a<textarea data-template>, usingflake-parts/scripts/inline-markdown.py. This means the copy inside the docs carries no.mdfile for MkDocs to render as a page.documentation.mkdocs-preBuildHookcopies the built deck intodocs/slides.watch-documentation, so a Markdown link would break the live preview..github/workflows/pages.ymlruns onubuntu-latestwithcachix/install-nix-action,upload-pages-artifactanddeploy-pages.Verified locally:
nix flake checkpasses./presentation/renders all 9 slides.file://with no console errors.watch-documentationstarts cleanly.🤖 Generated with Claude Code
https://claude.ai/code/session_0134mfNgkokU4oenUnqXigQz
Generated by Claude Code