Skip to content

ci: use rumdl to format Markdown - #113

Merged
henryiii merged 1 commit into
mainfrom
rumdl
Sep 15, 2026
Merged

henryiii merged 1 commit into
mainfrom
rumdl

Conversation

@henryiii

Copy link
Copy Markdown
Collaborator

🤖 AI text below 🤖

Switches Markdown formatting from prettier to rumdl.

.rumdl.toml sets flavor = "myst" so ```{directive} fences parse, and
MD013 reflows prose at 80 columns. slides/*.md use the standard flavor and
skip MD013, which matches the old proseWrap = "never" override. Prettier
still formats YAML, JSON, CSS, and JavaScript.

Two notes:

  • content/week01_git/advanced_steps.md is excluded. rumdl refuses to format
    any file that contains conflict markers, even inside a code block, and that
    check cannot be turned off per rule.
  • Rules that rewrite content rather than format it are disabled, each with a
    comment: MD014 (the console lexer needs the $ prefix), MD024, MD025,
    MD026, MD028, MD033, MD041, MD045, MD053, and MD059.

The content changes are the one-time reformat: reflow at 80, bare URLs to
autolinks, text added to 17 bare code fences, and blank lines normalized
between list items.

I did not run pixi run book, so the notebook-executing build is unverified.

rumdl replaces prettier for *.md. It knows the MyST flavor, so directive
fences parse correctly, and it leaves the Marp decks unwrapped. Prettier
keeps the other file types.

ClaudeCode:claude-opus-5
@henryiii
henryiii merged commit cf0dc0f into main Sep 15, 2026
4 checks passed
@henryiii
henryiii deleted the rumdl branch September 15, 2026 13:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant