markdown-callouts

Support GitHub "alerts" style of admonitions

To enable, add to mkdocs.yml:

markdown_extensions:
  - github-callouts
  # - callouts

This can be used instead of, or in addition to, the other callouts extension shipped by this package.

The syntax is:

> [!NOTE]
> Lorem ipsum dolor sit amet.

This syntax is supported by GitHub and looks like this there:

[!NOTE]
Lorem ipsum dolor sit amet.

And on the rendered MkDocs site it looks like a typical "NOTE" admonition.

Only 5 exact types are supported, and no extensibility of the syntax, just like on GitHub itself.

More details

Support collapsible <details> blocks

https://oprypin.github.io/markdown-callouts/#collapsible-blocks

>? TIP: **Click me to read more.**
>
> Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla.
>
> Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec
> semper lorem quam in massa.

Support custom title text for callouts

https://oprypin.github.io/markdown-callouts/#custom-titles

NOTE: **This is used as the title.** Lorem ipsum dolor sit amet, consectetur
adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non
consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.