Support for admonition extension #38

New Issue

claunia · 2026-01-29T14:22:17Z

claunia commented

2026-01-29 14:22:17 +00:00

Originally created by @mczachurski on GitHub (Jun 29, 2016).

Hi!

Could you add support for admonition extension? Admonition is simple markup which we can use to mark important part of documentation, it looks like this:

!!! note
    You should note that the title will be automatically capitalized.

Here is a more detailed description: Admonition Extension. And here is an example how it should looks rendered on the page:

Example from Read The Docs page .

I've tried to implement this using IMarkdownExtension (and BlockParser), however it's really hard without documentation (and BlockParser is not so obvious).

Best regards,
Marcin.

Originally created by @mczachurski on GitHub (Jun 29, 2016). Hi! Could you add support for admonition extension? Admonition is simple markup which we can use to mark important part of documentation, it looks like this: ``` !!! note You should note that the title will be automatically capitalized. ``` Here is a more detailed description: [Admonition Extension](https://pythonhosted.org/Markdown/extensions/admonition.html). And here is an example how it should looks rendered on the page: ![capture](https://cloud.githubusercontent.com/assets/6191974/16446127/5c2a87f4-3de6-11e6-813a-100de6c801fe.PNG) Example from [Read The Docs](http://read-the-docs.readthedocs.io/en/latest/theme.html) page . I've tried to implement this using IMarkdownExtension (and BlockParser), however it's really hard without documentation (and BlockParser is not so obvious). Best regards, Marcin.

claunia added the enhancement label 2026-01-29 14:22:17 +00:00

claunia closed this issue

2026-01-29 14:22:20 +00:00

claunia commented

2026-01-29 14:22:22 +00:00

@xoofx commented on GitHub (Jun 29, 2016):

Why not using custom containers?

:::note
You should note that the title will be automatically capitalized.
:::

With proper CSS styling it should be possible to achieve the same result.

@xoofx commented on GitHub (Jun 29, 2016): Why not using [custom containers](https://talk.commonmark.org/t/custom-container-for-block-and-inline/2051)? ``` :::note You should note that the title will be automatically capitalized. ::: ``` With proper CSS styling it should be possible to achieve the same result.

claunia commented

2026-01-29 14:22:26 +00:00

@xoofx commented on GitHub (Jun 30, 2016):

@mczachurski did you finally find your way with the custom container extension?

@xoofx commented on GitHub (Jun 30, 2016): @mczachurski did you finally find your way with the custom container extension?

claunia commented

2026-01-29 14:22:30 +00:00

@mczachurski commented on GitHub (Jul 1, 2016):

@xoofx yes it work like a charm. Thanks.

@mczachurski commented on GitHub (Jul 1, 2016): @xoofx yes it work like a charm. Thanks.

Sign in to join this conversation.

Branches Tags

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/markdig#38