# mdformat-admon
[![Build Status][ci-badge]][ci-link] [![PyPI version][pypi-badge]][pypi-link]
<!-- [![codecov.io][cov-badge]][cov-link]
[cov-badge]: https://codecov.io/gh/executablebooks/mdformat-admon/branch/main/graph/badge.svg
[cov-link]: https://codecov.io/gh/executablebooks/mdformat-admon
-->
An [mdformat](https://github.com/executablebooks/mdformat) plugin for formatting [`python-markdown` `admonitions`](https://python-markdown.github.io/extensions/admonition) and rendering the associated HTML.
> [!WARNING]
> `mdformat-admon` and `mdformat-mkdocs>=4.0.0` are no longer compatible. If you have both, you'll want to remove `mdformat-admon`
>
> The stylistic formatting for `mkdocs` differs from Python Markdown ([#22](https://github.com/KyleKing/mdformat-admon/pull/22)), so this package is now *only* for Python Markdown without mkdocs.
## `mdformat` Usage
Add this package wherever you use `mdformat` and the plugin will be auto-recognized. No additional configuration necessary. See [additional information on `mdformat` plugins here](https://mdformat.readthedocs.io/en/stable/users/plugins.html)
### Pre-Commit
```yaml
repos:
- repo: https://github.com/executablebooks/mdformat
rev: 0.7.19
hooks:
- id: mdformat
additional_dependencies:
- mdformat-admon
```
### pipx/uv
```sh
pipx install mdformat
pipx inject mdformat mdformat-admon
```
Or with uv:
```sh
uv tool run --from mdformat-admon mdformat
```
## HTML Rendering
To generate HTML output, `python_markdown_admon_plugin` can be imported from `mdit_plugins`. More plugins will be added in the future. For more guidance on `MarkdownIt`, see the docs: <https://markdown-it-py.readthedocs.io/en/latest/using.html#the-parser>
```py
from markdown_it import MarkdownIt
from mdformat_admon.mdit_plugins import python_markdown_admon_plugin
md = MarkdownIt()
md.use(python_markdown_admon_plugin)
text = '!!! note ""\n *content*'
md.render(text)
# <div class="admonition note">
# <p><em>content</em></p>
# </div>
```
## Contributing
See [CONTRIBUTING.md](https://github.com/KyleKing/mdformat-admon/blob/main/CONTRIBUTING.md)
[ci-badge]: https://github.com/kyleking/mdformat-admon/workflows/CI/badge.svg?branch=main
[ci-link]: https://github.com/kyleking/mdformat-admon/actions?query=workflow%3ACI+branch%3Amain+event%3Apush
[pypi-badge]: https://img.shields.io/pypi/v/mdformat-admon.svg
[pypi-link]: https://pypi.org/project/mdformat-admon
Raw data
{
"_id": null,
"home_page": null,
"name": "mdformat_admon",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9.0",
"maintainer_email": null,
"keywords": "markdown, markdown-it, mdformat, mdformat_plugin_template",
"author": null,
"author_email": "kyleking <dev.act.kyle@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/cb/42/5188f91e20ef1c563b4feb687f300c9ff4d16b4105dd94aab61bda8e3cef/mdformat_admon-2.1.1.tar.gz",
"platform": null,
"description": "# mdformat-admon\n\n[![Build Status][ci-badge]][ci-link] [![PyPI version][pypi-badge]][pypi-link]\n\n<!-- [![codecov.io][cov-badge]][cov-link]\n[cov-badge]: https://codecov.io/gh/executablebooks/mdformat-admon/branch/main/graph/badge.svg\n[cov-link]: https://codecov.io/gh/executablebooks/mdformat-admon\n -->\n\nAn [mdformat](https://github.com/executablebooks/mdformat) plugin for formatting [`python-markdown` `admonitions`](https://python-markdown.github.io/extensions/admonition) and rendering the associated HTML.\n\n> [!WARNING]\n> `mdformat-admon` and `mdformat-mkdocs>=4.0.0` are no longer compatible. If you have both, you'll want to remove `mdformat-admon`\n>\n> The stylistic formatting for `mkdocs` differs from Python Markdown ([#22](https://github.com/KyleKing/mdformat-admon/pull/22)), so this package is now *only* for Python Markdown without mkdocs.\n\n## `mdformat` Usage\n\nAdd this package wherever you use `mdformat` and the plugin will be auto-recognized. No additional configuration necessary. See [additional information on `mdformat` plugins here](https://mdformat.readthedocs.io/en/stable/users/plugins.html)\n\n### Pre-Commit\n\n```yaml\nrepos:\n - repo: https://github.com/executablebooks/mdformat\n rev: 0.7.19\n hooks:\n - id: mdformat\n additional_dependencies:\n - mdformat-admon\n```\n\n### pipx/uv\n\n```sh\npipx install mdformat\npipx inject mdformat mdformat-admon\n```\n\nOr with uv:\n\n```sh\nuv tool run --from mdformat-admon mdformat\n```\n\n## HTML Rendering\n\nTo generate HTML output, `python_markdown_admon_plugin` can be imported from `mdit_plugins`. More plugins will be added in the future. For more guidance on `MarkdownIt`, see the docs: <https://markdown-it-py.readthedocs.io/en/latest/using.html#the-parser>\n\n```py\nfrom markdown_it import MarkdownIt\nfrom mdformat_admon.mdit_plugins import python_markdown_admon_plugin\n\nmd = MarkdownIt()\nmd.use(python_markdown_admon_plugin)\n\ntext = '!!! note \"\"\\n *content*'\nmd.render(text)\n# <div class=\"admonition note\">\n# <p><em>content</em></p>\n# </div>\n```\n\n## Contributing\n\nSee [CONTRIBUTING.md](https://github.com/KyleKing/mdformat-admon/blob/main/CONTRIBUTING.md)\n\n[ci-badge]: https://github.com/kyleking/mdformat-admon/workflows/CI/badge.svg?branch=main\n[ci-link]: https://github.com/kyleking/mdformat-admon/actions?query=workflow%3ACI+branch%3Amain+event%3Apush\n[pypi-badge]: https://img.shields.io/pypi/v/mdformat-admon.svg\n[pypi-link]: https://pypi.org/project/mdformat-admon\n",
"bugtrack_url": null,
"license": null,
"summary": "An mdformat plugin for `admonition`.",
"version": "2.1.1",
"project_urls": {
"Bug Tracker": "https://github.com/kyleking/mdformat-admon/issues",
"Changelog": "https://github.com/kyleking/mdformat-admon/releases",
"homepage": "https://github.com/kyleking/mdformat-admon"
},
"split_keywords": [
"markdown",
" markdown-it",
" mdformat",
" mdformat_plugin_template"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "9e0d1d9a3a59295ce2236bec57a90a32a81bb268aad03e1daa3b40db7e9f44a7",
"md5": "860031a5583c7b23a1dd72ca4d3e8607",
"sha256": "f2efae84da6d4eaa453a7cf0eca7437dc1c1e347a0780abfa5eecfdda03630c2"
},
"downloads": -1,
"filename": "mdformat_admon-2.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "860031a5583c7b23a1dd72ca4d3e8607",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9.0",
"size": 10960,
"upload_time": "2025-04-09T10:55:44",
"upload_time_iso_8601": "2025-04-09T10:55:44.356010Z",
"url": "https://files.pythonhosted.org/packages/9e/0d/1d9a3a59295ce2236bec57a90a32a81bb268aad03e1daa3b40db7e9f44a7/mdformat_admon-2.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "cb425188f91e20ef1c563b4feb687f300c9ff4d16b4105dd94aab61bda8e3cef",
"md5": "e662320d9a3849759a532d3316d01deb",
"sha256": "605df53bec06eba63f0ad510f7f67cdead9c328ec807bca1db76026a66a68d9e"
},
"downloads": -1,
"filename": "mdformat_admon-2.1.1.tar.gz",
"has_sig": false,
"md5_digest": "e662320d9a3849759a532d3316d01deb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9.0",
"size": 13317,
"upload_time": "2025-04-09T10:55:45",
"upload_time_iso_8601": "2025-04-09T10:55:45.708428Z",
"url": "https://files.pythonhosted.org/packages/cb/42/5188f91e20ef1c563b4feb687f300c9ff4d16b4105dd94aab61bda8e3cef/mdformat_admon-2.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-04-09 10:55:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kyleking",
"github_project": "mdformat-admon",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "mdformat_admon"
}
JSON
