Markdown-callouts

Latest version: v0.4.0

Safety actively analyzes 682387 Python packages for vulnerabilities to keep your Python projects secure.

Scan your dependencies

0.4.0

Support GitHub "alerts" style of admonitions

To enable, add to `mkdocs.yml`:

yaml
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:

markdown
> [!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**](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts)

0.3.0

Support collapsible `<details>` blocks

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

markdown
>? 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.


![Screenshot_20220918_224723](https://user-images.githubusercontent.com/371383/190927536-547946d4-4c2f-41fd-8982-ee5cb1336d78.png)

0.2.0

Support custom title text for callouts

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

markdown
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.


![image](https://user-images.githubusercontent.com/371383/141678325-7365ddc8-e277-43bb-8497-a7e1ccfda1dd.png)

Links

Releases

Has known vulnerabilities

© 2024 Safety CLI Cybersecurity Inc. All Rights Reserved.