README themes
Edit README.md.src for project content. README.md is generated by the native mdtheme CLI. It does not require Node.js. Shared branding stays in the theme repositories.
With mise installed, run from the repository root:
mise trust
mise install --locked
mise run readme:write
mise run readme:checkCommit the source and generated README together. CI checks the complete output.
mise run readme:pre-push regenerates the README and refuses a push with an
uncommitted worktree; it never stages or commits files. To use it as a local
pre-push hook, call it from your existing hook.
The CLI is pinned in mise.toml and verified through mise.lock. Theme revisions
are pinned in mdtheme.yaml: change a ref and regenerate to review an update.
Git branches such as main are supported too, but a pin keeps CI reproducible.
Theme retrieval needs Git and network access, including in check mode.
The outer Sebastian theme adds its badge and closes with the company logo and consulting footer. The inner Ferramenta theme introduces the family and closes with its icon and sibling links. Each sibling has a short description; this project is excluded. Project content stays between the two frames.
Published subpackage READMEs retain their compact registry family blocks and existing regeneration command. The root README uses native theme composition.
See the living decision.
Theme badge placement
The project pins mdtheme 0.4.0 and uses one mdtheme:badges:start /
mdtheme:badges:end comment pair in README.md.src. Sebastian's
badges-prepend.md places its badge before the authored project badges.
Ferramenta's header and footer stay unchanged. Upgrade the CLI and lockfile
before adopting this theme revision. Keep badge markup outside raw HTML blocks.