markdown-callouts

What it is and what it does

markdown-callouts is a Python-Markdown extension that provides a simpler, more readable syntax for creating admonition blocks (callouts) compared to the standard admonition extension. Instead of the verbose `!!!` syntax, it lets you write `NOTE:` or `>? NOTE:` at the start of a paragraph to create highlighted, set-apart blocks. The extension produces the same rendered output as the admonition extension but with syntax that reads more naturally and degrades gracefully in vanilla Markdown renderers like GitHub's—showing the text with a clear prefix rather than disappearing or rendering as raw markup.

It's designed for documentation sites using MkDocs and themes like mkdocs-material that support admonitions. The package supports collapsible blocks via the `>?` prefix syntax. With a single runtime dependency (markdown) and support for Python 3.8 through 3.12, it integrates straightforwardly into existing Markdown workflows.

Use it for:

• Add visually distinct NOTE, WARNING, or INFO blocks to MkDocs documentation without verbose syntax.
• Create collapsible admonition blocks in documentation that expand on user interaction.
• Write Markdown that reads naturally in both rendered HTML and raw text (GitHub preview).
• Migrate from admonition syntax to a more readable block syntax in existing Markdown projects.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Adds a cleaner block-level syntax to Markdown for creating highlighted admonition blocks (callouts) that degrade gracefully in vanilla renderers.

Yes. Low install friction, no security issues, actively maintained, and solves a real readability problem for Markdown documentation. Useful if you write docs in Markdown and want cleaner admonition syntax; skip it if you don't use admonitions or prefer the standard syntax.

Install

markdown-callouts on PyPI

pip install markdown-callouts

uv add markdown-callouts

poetry add markdown-callouts

Installing markdown-callouts

Before you install

Low friction: pure Python wheel with a single dependency on markdown. Actively maintained with recent commits and no known vulnerabilities.

License in practice

MIT license (permissive): you can use, modify, and distribute this package freely with minimal restrictions.

Quickstart

pip install markdown-callouts

In mkdocs.yml:
markdown_extensions:
  - callouts

Then in Markdown:
NOTE: Your highlighted text here.

Requires markdown package; intended for use with Markdown processors or static site generators like MkDocs.

Verify before relying

• Whether the package works with markdown versions older than the current release.
• Performance characteristics when processing large documents with many callouts.

Package facts

Evidence: markdown_callouts-0.4.0-py3-none-any.whl

Keywords: extensions, markdown

Tags

More Documentation packages