Skip to content

colon fence syntax is broken by escape characterΒ #13

@arwedus

Description

@arwedus

Describe the problem

In case of a colon fence:

:::{NOTE}

README.md should contain the component or package name in it's title.
Using only README as title will lead to lots of "README" items in the outline of the generated documentation.
:::

mdformat produces:

:::\{NOTE}

README.md should contain the component or package name in it's title.
Using only README as title will lead to lots of "README" items in the outline of the generated documentation.
:::

Ideally, mdformat with mdformat_myst would respect this syntax and not escape it.

To me, it is not even clear why mdformat escapes curly brackets in the first place.

Link to your repository or website

No response

Steps to reproduce

  1. "pip install mdformat_myst"
  2. Put the above example in a .md file
  3. run "mdformat filename.md"

The version of Python you're using

3.8

Your operating system

Ubuntu 20.04

Versions of your packages

mdformat==0.7.10
mdformat_frontmatter==0.4.1
mdformat_myst==0.1.4
mdformat_tables==0.4.1

Additional context

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions