Support for Admonition syntax (non-standard)
See original GitHub issuePlease add support for Admonitions!
https://python-markdown.github.io/extensions/admonition/
Admonitions are created using the following syntax:
!!! type "optional explicit title within double quotes" Any number of other indented markdown elements. This is the second paragraph.
Since I am a mkdocs-material user, it would be really great to have this. Even in a previewer in vscode admonitions are displayed.
Issue Analytics
- State:
- Created 4 years ago
- Reactions:1
- Comments:14 (6 by maintainers)
Top Results From Across the Web
Admonitions - Material for MkDocs
Each of the supported admonition types has a distinct icon, ... Admonitions follow a simple syntax: a block starts with !!! , followed...
Read more >reStructuredText Directives - Docutils
This document describes the directives implemented in the reference reStructuredText parser. Directives have the following syntax:
Read more >Markdown reference for Microsoft Learn - Contributor guide
Markdown is a lightweight markup language with plain text formatting syntax. The Microsoft Learn platform supports CommonMark compliant ...
Read more >Adding HTML attributes to a multi-line section of markdown
markdown=1. The mention of "the markdown attribute" above is referring to a non-standard add-on to the Markdown syntax which Kramdown supports ...
Read more >The reason why there are just so many tool around… - types.pl
All off these options involve a bunch of nonstandard, incompatible syntax bolted ... The biggest offender to me though so far is GitHub's...
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
The CLI does not currently support markdown-it plugins.
@berot3 @Stanzilla did any of you have luck with what David proposed? I just tried hacking the plugin into the
markdownlint-cli
options passed tomarkdownlint
, but it doesn’t seem to do anything -markdownlint
still interprets paragraphs in admonition as indented code blocks:@DavidAnson just to confirm - below is what you have been proposing, right?
If we can get this to work, I’d consider making a PR to have this supported in
markdownlint-cli
.