{"author":"","author_email":"Oleh Prypin ","bugtrack_url":null,"classifiers":["Development Status :: 4 - Beta","Environment :: Web Environment","Intended Audience :: Information Technology","License :: OSI Approved :: MIT License","Operating System :: OS Independent","Programming Language :: Python","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.11","Programming Language :: Python :: 3.12","Programming Language :: Python :: 3.8","Programming Language :: Python :: 3.9","Topic :: Documentation","Topic :: Software Development :: Documentation","Topic :: Text Processing :: Markup :: Markdown","Typing :: Typed"],"description":"# markdown-callouts\n\n**Extension for [Python-Markdown][]: a classier syntax for [admonitions](https://squidfunk.github.io/mkdocs-material/reference/admonitions/#usage)**\n\n[![PyPI](https://img.shields.io/pypi/v/markdown-callouts)](https://pypi.org/project/markdown-callouts/)\n[![GitHub](https://img.shields.io/github/license/oprypin/markdown-callouts)](https://github.com/oprypin/markdown-callouts/blob/master/LICENSE.md)\n[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/oprypin/markdown-callouts/ci.yml.svg)](https://github.com/oprypin/markdown-callouts/actions?query=event%3Apush+branch%3Amaster)\n\n[python-markdown]: https://python-markdown.github.io/\n[admonition]: https://python-markdown.github.io/extensions/admonition/\n[mkdocs]: https://www.mkdocs.org/\n[documentation site]: https://oprypin.github.io/markdown-callouts/\n\n## Installation\n\n```shell\npip install markdown-callouts\n```\n\nIf using MkDocs, [enable the extension in **mkdocs.yml**](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions):\n\n```yaml\nmarkdown_extensions:\n - callouts\n```\n\n**Continue to the [documentation site][].**\n\n## Usage\n\nThis adds a new block-level syntax to Markdown, to put a paragraph of text into a block that's specially highlighted and set apart from the rest of the text.\n\n**Example:**\n\n```markdown\nNOTE: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod\nnulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor\nmassa, nec semper lorem quam in massa.\n```\n\n**Result**, [using *mkdocs-material*](https://squidfunk.github.io/mkdocs-material/reference/admonitions/#usage):\n\n![Screenshot](https://user-images.githubusercontent.com/371383/119063216-dc001700-b9d8-11eb-8092-763e5d02d9f4.png)\n\nCollapsible blocks also have a syntax for them:\n\n```markdown\n>? NOTE: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod\n> nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor\n> massa, nec semper lorem quam in massa.\n```\n\nThis instead shows up as an initially-closed `

` block.\n\n### Graceful degradation\n\nThis extension produces the same results as the *[admonition][]* extension, but with a syntax that is much less intrusive and has a very reasonable fallback look for \"vanilla\" renderers.\n\nE.g. compare what you would've seen above if we actually wrote that Markdown and fed it to GitHub's Markdown parser:\n\n\n\n\n\n\n

\"Callouts\" syntax
\n\nNOTE: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod\nnulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor\nmassa, nec semper lorem quam in massa.\n\n
\"Admonition\" syntax
\n\n!!! note\n\n Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod\n nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor\n massa, nec semper lorem quam in massa.\n\n

\n\n---\n\n**Continue to the [documentation site][].**\n","description_content_type":"text/markdown","docs_url":null,"download_url":"","downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":"","keywords":"extensions,markdown","license":"","license_expression":null,"license_files":null,"maintainer":"","maintainer_email":"","name":"markdown-callouts","package_url":"https://pypi.org/project/markdown-callouts/","platform":null,"project_url":"https://pypi.org/project/markdown-callouts/","project_urls":{"Documentation":"https://oprypin.github.io/markdown-callouts/","History":"https://github.com/oprypin/markdown-callouts/releases","Issues":"https://github.com/oprypin/markdown-callouts/issues","Source":"https://github.com/oprypin/markdown-callouts"},"provides_extra":null,"release_url":"https://pypi.org/project/markdown-callouts/0.4.0/","requires_dist":["markdown>=3.3.3"],"requires_python":">=3.8","summary":"Markdown extension: a classier syntax for admonitions","version":"0.4.0","yanked":false,"yanked_reason":null}

Package search

markdown-callouts

project_urls

Dependencies

All package metadata

Releases