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

Support admonition markdown extension syntax #51

Open
mschoettle opened this issue Apr 25, 2024 · 2 comments
Open

Support admonition markdown extension syntax #51

mschoettle opened this issue Apr 25, 2024 · 2 comments
Assignees

Comments

@mschoettle
Copy link

mschoettle commented Apr 25, 2024

Is your feature request related to a problem?

Hi @aepfli. I came across your rule through the discussion on one of the markdownlint repos. Thanks for this rule!

I started trying it out and there is one case where this rule complains that would be nice if it supported it.

We use mkdocs-material (https://squidfunk.github.io/mkdocs-material/) and make use of the admonition extension (see https://squidfunk.github.io/mkdocs-material/reference/admonitions/).

Unfortunately all lines with !!! ... and ??? ... (e.g., !!! note) cause a max-one-sentence-per-line violation.

Describe the solution you'd like

It would be great if this admonition syntax could be excluded without requiring to specifically add disable comments on the preceding line.

Describe alternatives you've considered

See above.

Additional context

n/a

aepfli added a commit that referenced this issue Apr 25, 2024
Signed-off-by: Simon Schrottner <[email protected]>
@aepfli aepfli self-assigned this Apr 25, 2024
@aepfli
Copy link
Owner

aepfli commented Apr 25, 2024

Hey, first of all, thank you for the issue. I am happy that my code helps some people out there.

The solution I propose in #52 is merely a bandaid and a hack around the problem. But till I come up with a better solution, I think it is feasible with little configuration effort.

I'll think about a better approach, but please let me know if this helps you and is sufficient for the time being.

all the best
simon

@mschoettle
Copy link
Author

Thanks Simon for the quick response and fix. This workaround would help for the time being.

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

No branches or pull requests

2 participants