Admonitions in Goldmark?

[cdupont]

Some Markdown flavors supports "admonitions" (also named "call outs"): https://python-markdown.github.io/extensions/admonition/
They are useful for putting something forward in the flow of text.
For instance, using "!!!" as syntax for the admonition:

!!! warning
    Warning, this tutorial is in development.

Results in something like that:

Several types of admonitions can be supported, such as "note", "tip", "warning" or "action".

Do you think this would be useful? I think it could be implemented as an extension (I could try, time permitting :).

[tomcam]

I would absolutely love it but it's not in the CommonMark spec nor in the other extensions already supported, such as the PHP and GitHub extensions.

[vanbroup]

Note
GitHub does now has limited support for Admonitions

GitHub does now: community/community#16925

[u0nel]

hedge doc uses colons:

:::warning
The warning
:::

https://demo.hedgedoc.org/eqY3mmlXT_qTFMB9L1_rLg#

[jiriks74]

Github currently support the following syntax in all places where Markdown is present.

> [!Note]
> This is a note

Note

This is a note.

Others are possible:

Tip

This is a tip!

Warning

This is a warning!

Important

This is important!

Caution

Be cautious!

The same syntax is currently supported by Gitea too.

---

For more information see this Github discussion