Support for "ignore" comments about mdformat HOT 5 OPEN

Hi folks, any updates here? This is currently a bit of a deal breaker for me.

from mdformat.

No one is currently working on this to my knowledge.

It seems you also need support for the non-standard admonition syntax, so seems like a plugin that brings support for that syntax would help you as well.

from mdformat.

Hi @jamescurtin and thanks for the issue!

I like the feature.

Some notes/thoughts regarding implementation already 😄

• reference links (spanning in and out of the ignored block) could be problematic
• I think deciding what to ignore has to happen after parsing. Doing so before parser is problematic because, e.g. there is no ignore block in the MD below, and it's difficult to know that without parsing:

  <!-- mdformat ignore start -->
  

• The token stream the renderer currently receives is abstract, not concrete syntax. The renderer doesn't know the original formatting. One way or the other it would have to I guess.

I'm expecting a bug free implementation could be quite hard to come up with. A plugin that brings formatting support for admonition (that you mentioned) might be easier (although not as general solution ofc).

It looks like there's a similar discussion happening on an existing PR about how to ignore blocks of code.

This discussion is related to ignoring stuff from a safeguard that ensures mdformat does not alter markdown AST. All markdown is still formatted, so it's not really the same thing.

Hi @hukkin , is there any progress to support the feature?

from mdformat.

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! 🎉

from mdformat.

Hi @jamescurtin and thanks for the issue!

I like the feature.

Some notes/thoughts regarding implementation already 😄

• reference links (spanning in and out of the ignored block) could be problematic
• I think deciding what to ignore has to happen after parsing. Doing so before parser is problematic because, e.g. there is no ignore block in the MD below, and it's difficult to know that without parsing:

  <!-- mdformat ignore start -->
  ```
  <!-- mdformat ignore end -->
  ```

• The token stream the renderer currently receives is abstract, not concrete syntax. The renderer doesn't know the original formatting. One way or the other it would have to I guess.

I'm expecting a bug free implementation could be quite hard to come up with. A plugin that brings formatting support for admonition (that you mentioned) might be easier (although not as general solution ofc).

It looks like there's a similar discussion happening on an existing PR about how to ignore blocks of code.

This discussion is related to ignoring stuff from a safeguard that ensures mdformat does not alter markdown AST. All markdown is still formatted, so it's not really the same thing.

from mdformat.