Skip to content

Inline Ignore

To use the inline ignore feature, add an attribute to the code block you do not wish to convert like so: ```{.rst rst-in-md=false}. This will prevent the rst-in-md tool from converting the fenced code block directly following the comment.

Bare in mind, you will need to add a comment for each code block you want to ignore. To understand why it was implemented this way, check out the implementation guide.

Ignore conversion

How the ignore attribute works:

Before

ignore.md
    ```{.rst rst-in-md=false}
    With this comment, this will be ignored by the `rst-in-md` tool.
    ```

After

With this comment, this will be ignored by the `rst-in-md` tool.

With conversion

Before

normal.md
    ```rst
    This will be converted by the `rst-in-md` tool.
    ```

After

This will be converted by the rst-in-md tool.