Skip to content

Support for "ignore" comments #53

@jamescurtin

Description

@jamescurtin

Is your feature request related to a problem? Please describe.

Some officially supported Python Markdown extensions (like admonition use non-standard Markdown syntax. These cases are not properly handled by the parser currently. For example:

# Some title

!!! note
This will render as a tooltip box.

Back to normal markdown content.

Describe the solution you'd like

It would be useful if there was an "ignore" comment that could be added to a markdown file to skip formatting specific sections. The prettier library uses <!-- prettier-ignore --> and <!-- prettier-ignore-end --> for this purpose.

Describe alternatives you've considered

Plugins could be written for to handle cases like this, but it would be useful if there was a global way to disable formatting in specific sections of a document.

Additional context

It looks like there's a similar discussion happening on an existing PR about how to ignore blocks of code. I'd be fine with a solution where I could wrap certain sections in a div that sets a class that's globally ignored, but I feel like a plain comment would be a better interface for this use case, as it wouldn't require modifying the AST of the markdown.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions