{"id":15023080,"url":"https://github.com/oprypin/markdown-callouts","last_synced_at":"2025-10-25T16:30:53.682Z","repository":{"id":45142690,"uuid":"363785089","full_name":"oprypin/markdown-callouts","owner":"oprypin","description":"Markdown extension: a classier syntax for admonitions","archived":false,"fork":false,"pushed_at":"2024-02-11T18:55:19.000Z","size":92,"stargazers_count":28,"open_issues_count":5,"forks_count":12,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-10-30T01:43:46.208Z","etag":null,"topics":["admonition","markdown","markdown-extension","mkdocs","python-markdown"],"latest_commit_sha":null,"homepage":"https://oprypin.github.io/markdown-callouts","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/oprypin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"oprypin"}},"created_at":"2021-05-03T01:07:19.000Z","updated_at":"2024-09-20T18:45:10.000Z","dependencies_parsed_at":"2023-02-16T00:45:41.773Z","dependency_job_id":"7282b618-0897-4ba5-84ec-0ed14be269bd","html_url":"https://github.com/oprypin/markdown-callouts","commit_stats":{"total_commits":29,"total_committers":1,"mean_commits":29.0,"dds":0.0,"last_synced_commit":"c5efaa66fa1151f2eb469fc71b3e99b51f9bbfc6"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oprypin%2Fmarkdown-callouts","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oprypin%2Fmarkdown-callouts/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oprypin%2Fmarkdown-callouts/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oprypin%2Fmarkdown-callouts/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oprypin","download_url":"https://codeload.github.com/oprypin/markdown-callouts/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238174140,"owners_count":19428631,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["admonition","markdown","markdown-extension","mkdocs","python-markdown"],"created_at":"2024-09-24T19:58:42.913Z","updated_at":"2025-10-25T16:30:53.171Z","avatar_url":"https://github.com/oprypin.png","language":"Python","readme":"# 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[![License](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\u003e? NOTE: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod\n\u003e nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor\n\u003e massa, nec semper lorem quam in massa.\n```\n\nThis instead shows up as an initially-closed `\u003cdetails\u003e` 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\u003ctable markdown=\"1\"\u003e\n\u003ctr\u003e\u003cth\u003e\"Callouts\" syntax\u003c/th\u003e\u003c/tr\u003e\n\u003ctr\u003e\u003ctd\u003e\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\u003c/td\u003e\u003c/tr\u003e\n\u003ctr\u003e\u003cth\u003e\"Admonition\" syntax\u003c/th\u003e\u003c/tr\u003e\n\u003ctr\u003e\u003ctd\u003e\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\u003c/td\u003e\u003c/tr\u003e\n\u003c/table\u003e\n\n### Support GitHub \"alerts\" style of admonitions\n\nTo enable, add to mkdocs.yml:\n```\nmarkdown_extensions:\n  - github-callouts\n```\nThis can be used instead of, or in addition to, the other callouts extension shipped by this package. This adds support for [GitHub-style alerts](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts).\n\nThe syntax is:\n```\n\u003e [!NOTE]\n\u003e Lorem ipsum dolor sit amet.\n```\n\n---\n\n**Continue to the [documentation site][].**\n","funding_links":["https://github.com/sponsors/oprypin"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foprypin%2Fmarkdown-callouts","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foprypin%2Fmarkdown-callouts","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foprypin%2Fmarkdown-callouts/lists"}