Consider using Markdown linter / formatter in build process #20

Open
opened 2026-04-20 17:23:02 +00:00 by msz · 0 comments
Member

When writing Jinja templates, I find it hard to get the new lines I want without introducing ones that I don't (e.g. blank line before a list, blank line above heading, no consecutive blank lines between content).

I know that this can be improved by people more versed in Jinja than I am. I also know that markdown is essentially an intermediate product intended for use by Hugo, so as long as our markdown output is syntactically correct and reproducible, formatting details should not matter.

However, I still want to output good looking markdown pages. I have been experimenting with rumdl, a markdown linter and formatter written in rust. It can be installed with uv, and the binary is 13MB (note, there is also markdownlint, available in Debian, but it is a linter without reformatting ability). I tried on a few pages (rumdl check --disable MD013 ... and rumdl fmt --disable MD013 ...) and it works OK.

I wanted to ask whether including rumdl in the page build workflow would be met with approval, considering the non-essential nature of the thing.

When writing Jinja templates, I find it hard to get the new lines I want without introducing ones that I don't (e.g. blank line before a list, blank line above heading, no consecutive blank lines between content). I know that this can be improved by people more versed in Jinja than I am. I also know that markdown is essentially an intermediate product intended for use by Hugo, so as long as our markdown output is syntactically correct and reproducible, formatting details should not matter. However, I still want to output good looking markdown pages. I have been experimenting with [rumdl](https://github.com/rvben/rumdl), a markdown linter and formatter written in rust. It can be installed with `uv`, and the binary is 13MB (note, there is also [markdownlint](https://github.com/markdownlint/markdownlint), available in Debian, but it is a linter without reformatting ability). I tried on a few pages (`rumdl check --disable MD013 ...` and `rumdl fmt --disable MD013 ...`) and it works OK. I wanted to ask whether including `rumdl` in the page build workflow would be met with approval, considering the non-essential nature of the thing.
Sign in to join this conversation.
No labels
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
www/www-from-model#20
No description provided.