Skip to content

Add MDFormat? #353

@flying-sheep

Description

@flying-sheep

Switching from Prettier to Biome removed our markdown formatting, but that might be a blessing in disguise, see comments following #283 (comment), summarized here:

  • Prettier didn’t support MyST syntax extensions, so its markdown formatting might break at any time

  • Even MDFormat doesn’t support any MyST plugins that aren’t part of the default list: colon fence syntax is broken by escape character executablebooks/mdformat-myst#13 (comment)

    One example is colon fences, so enabling MDFormat would break the docs for people who have started use colon fences and who then update using cruft (sure, not a huge problem, can be fixed in a PR)

PS: I will always be bitter that the community chose Markdown. rST is designed with extensibility in mind, so if everyone used it, there would be no such thing as “incompatible syntax extensions” that could break formatters.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions