Hongdown: An opinionated Markdown formatter in Rust (github.com)

submitted 3 weeks ago by hongminhee@lemmy.ml to c/rust@programming.dev

7 comments fedilink hide all child comments

you are viewing a single comment's thread
view the rest of the comments

[-] hongminhee@lemmy.ml 4 points 2 weeks ago

Thanks for the feedback! The style choices are intentional and all valid CommonMark:

Heading styles: Setext (===/---) for H1/H2 makes major sections visually prominent in plain text, while ATX (###) is used for deeper levels. This hybrid approach optimizes readability in the raw source.
Four tildes: Tildes are valid CommonMark delimiters, just less common. They're chosen because code often contains backticks (shell commands, string literals), so tildes avoid visual clutter.

The core philosophy is that Markdown should be readable as plain text, not just after rendering. These choices prioritize scanning structure in a text editor. That said, it's definitely an opinionated style—not for everyone!