Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add warning of incompatibility with mdformat-mkdocs #23

Merged
merged 1 commit into from
Dec 16, 2024
Merged

docs: add warning of incompatibility with mdformat-mkdocs #23

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@
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]
> This package used to support a set of helpers to build variations of admonition syntaxes and rendering the associated HTML, but that code has been moved to [`mdformat-plugin-template`](https://github.com/KyleKing/mdformat-plugin-template) in the [`_synced/admon_factories/*.py` directory](https://github.com/KyleKing/mdformat-plugin-template/blob/f1fb9ebabab04187b17388730062594de7c18283/package_template/mdformat_%7B%7B%20plugin_name%20%7D%7D/_synced/admon_factories/README.md).
> `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

Expand Down
Loading