Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

colon fence syntax is broken by escape character #13

Open
arwedus opened this issue Nov 29, 2021 · 3 comments
Open

colon fence syntax is broken by escape character #13

arwedus opened this issue Nov 29, 2021 · 3 comments
Labels
enhancement New feature or request

Comments

@arwedus
Copy link

arwedus commented Nov 29, 2021

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

@arwedus arwedus added the bug Something isn't working label Nov 29, 2021
@welcome
Copy link

welcome bot commented Nov 29, 2021

Thanks for opening your first issue here! Engagement like this is essential for open source projects! 🤗

If you haven't done so already, check out EBP's Code of Conduct. Also, please try to follow the issue template as it helps other community members to contribute more effectively.

If your issue is a feature request, others may react to it, to raise its prominence (see Feature Voting).

Welcome to the EBP community! 🎉

@hukkin
Copy link
Collaborator

hukkin commented Nov 30, 2021

The plugin only supports syntax extensions that are on by default in MyST. Colon fence is not a supported syntax currently.

@adamgayoso
Copy link

Will this be supported in the future?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants