Skip to content

v0.4.0

Latest
Compare
Choose a tag to compare
@oprypin oprypin released this 22 Jan 23:24
· 2 commits to master since this release
4ca849a

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