pymarkdown icon indicating copy to clipboard operation
pymarkdown copied to clipboard

Admonitions support & MD046 false positive

Open skwde opened this issue 3 months ago • 0 comments

Prerequisites

  • [x] Are you running the latest version of this application?
  • [x] Have you checked the Frequently Asked Questions document?
  • [x] Did you perform a cursory search of other issues to look for related issues?

Feature Request

Python Markdown Admonition (https://python-markdown.github.io/extensions/admonition/) support.

MD046 triggers a false positive on such an admonition.

Maybe somewhat related: https://github.com/jackdewinter/pymarkdown/issues/287

Description

The following test.md

# test

!!! note "admonition"
    abca

    abaca

```sh
touch abc
```

gives

test.md:6:5: MD046: Code block style [Expected: fenced; Actual: indented] (code-block-style)

when I run

pymarkdown scan test.md

Desired Behavior of Feature

Support for adminitions would be superb.

What Are the Benefits of This Feature?

This type of admonitions are commonly used in technical documentation using the popular mkdocs material theme.

Besides that, some mkdocs specific rules are already present (PML100, PML101).

skwde avatar Nov 21 '24 13:11 skwde