chore: use rumdl for Markdown formatting#9
Merged
Merged
Conversation
Move Markdown formatting from prettier to rumdl (mystmd flavor for content/, standard for the Marp slides/). prettier stays for the non-Markdown files (CSS, JSON, YAML) via an `\.md$` exclude. rumdl fmt's directive-aware fixes (MD031) add blank lines around MyST directives; MD013/MD033/MD026/MD076 are disabled as they don't fit prose/slide content. Assisted-by: ClaudeCode:claude-opus-4.8
Merged
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.
🤖 AI text below 🤖
Move Markdown formatting from prettier to rumdl.
What changed
.pre-commit-config.yaml— added therumdl-fmthook (rumdl-pre-commit v0.2.27); prettier stays but now excludes\.md$, so rumdl owns Markdown and prettier keeps CSS / JSON / YAML..rumdl.toml(new) —content/**/*.mduses themystflavor (directive/role aware);slides/stays standard Markdown (Marp). DisabledMD013(line length),MD033(inline HTML — Marp<div class="columns">),MD026(intentional trailing:in slide headings), andMD076(false-positive on a mixed-indent:::{card}).AGENTS.md/CLAUDE.mdlist rumdl alongside prettier.Formatting the switch applied
content/basic-packaging/01_setup.md— blank lines added around MyST directives (MD031, myst-flavor aware).README.md— bare URL wrapped in<…>(MD034).slides/1_01_setup.md—textlanguage added to a fenced block (MD040).Verification
bun run build— book + slides build with no directive warnings.prek -a— full suite green (rumdl fmtandprettierboth pass).