mdformat-mkdocs 5.2.0b0__tar.gz → 5.2.0b1__tar.gz

{mdformat_mkdocs-5.2.0b0 → mdformat_mkdocs-5.2.0b1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mdformat_mkdocs
-Version: 5.2.0b0
+Version: 5.2.0b1
 Summary: An mdformat plugin for mkdocs and Material for MkDocs
 Keywords: markdown,markdown-it,mdformat,mdformat_plugin_template
 Author: kyleking
@@ -32,6 +32,7 @@ Requires-Dist: mdformat-hooks>=0.1.0 ; extra == 'recommended-mdsf'
 Requires-Dist: mdformat-simple-breaks>=0.0.1 ; extra == 'recommended-mdsf'
 Requires-Dist: mdformat-wikilink>=0.2.0 ; extra == 'recommended-mdsf'
 Requires-Dist: beartype>=0.21.0 ; extra == 'test'
+Requires-Dist: hypothesis>=6.100.0 ; extra == 'test'
 Requires-Dist: pytest>=9.0.1 ; extra == 'test'
 Requires-Dist: pytest-beartype>=0.2.0 ; extra == 'test'
 Requires-Dist: pytest-cov>=7.0.0 ; extra == 'test'
@@ -79,6 +80,23 @@ Supports:
 - [Python Markdown "Snippets"\*](https://facelessuser.github.io/pymdown-extensions/extensions/snippets)
     - \*Note: the markup (HTML) renders the plain text without implementing the snippet logic. I'm open to contributions if anyone needs full support for snippets
 
+### Features with Implicit Support
+
+The following MkDocs/Material/PyMdown syntax passes through mdformat-mkdocs unchanged — it is not modified or corrupted, but it is also not actively normalized:
+
+- [PyMdown Keys](https://facelessuser.github.io/pymdown-extensions/extensions/keys/) — `++ctrl+alt+del++` (not a markdown construct, preserved as-is)
+- [PyMdown Critic Markup](https://facelessuser.github.io/pymdown-extensions/extensions/critic/) — `{--deleted--}`, `{++added++}`, `{~~old~>new~~}`, `{==highlight==}`, `{>>comment<<}`
+- [PyMdown Highlight](https://facelessuser.github.io/pymdown-extensions/extensions/mark/) — `==marked text==`
+- [PyMdown Caret / Tilde](https://facelessuser.github.io/pymdown-extensions/extensions/caret/) — `H^2^O`, `CH~3~OH`
+- [PyMdown Emoji](https://facelessuser.github.io/pymdown-extensions/extensions/emoji/) — `:smile:`, `:material-icon:`
+- [PyMdown InlineHilite](https://facelessuser.github.io/pymdown-extensions/extensions/inlinehilite/) — language hints inside backtick spans (`:::python code`) are never modified
+- [PyMdown SmartSymbols](https://facelessuser.github.io/pymdown-extensions/extensions/smartsymbols/) — `(c)`, `(tm)`, `--`, `-->` are plain ASCII in source and not touched
+- [PyMdown MagicLink](https://facelessuser.github.io/pymdown-extensions/extensions/magiclink/) — `@username`, `#123` are plain text and pass through
+- [Material Grids](https://squidfunk.github.io/mkdocs-material/reference/grids/) — `<div class="grid cards" markdown>` is an HTML block; content is preserved but markdown inside is not reformatted
+- [Mermaid / Superfences](https://squidfunk.github.io/mkdocs-material/reference/diagrams/) — diagram code inside fenced blocks is never modified
+
+**Note on [PyMdown ProgressBar](https://facelessuser.github.io/pymdown-extensions/extensions/progressbar/)**: The syntax `[=50% "50%"]` resembles an undefined link reference and will be escaped to `\[=50% "50%"\]` by default. Use `--ignore-missing-references` to preserve it, or avoid this extension if you use mdformat without that flag.
+
 See the example test files, [./tests/pre-commit-test.md](https://raw.githubusercontent.com/KyleKing/mdformat-mkdocs/main/tests/pre-commit-test.md) and [./tests/format/fixtures.md](https://raw.githubusercontent.com/KyleKing/mdformat-mkdocs/main/tests/format/fixtures.md)
 
 ## `mdformat` Usage

{mdformat_mkdocs-5.2.0b0 → mdformat_mkdocs-5.2.0b1}/README.md

@@ -32,6 +32,23 @@ Supports:
 - [Python Markdown "Snippets"\*](https://facelessuser.github.io/pymdown-extensions/extensions/snippets)
     - \*Note: the markup (HTML) renders the plain text without implementing the snippet logic. I'm open to contributions if anyone needs full support for snippets
 
+### Features with Implicit Support
+
+The following MkDocs/Material/PyMdown syntax passes through mdformat-mkdocs unchanged — it is not modified or corrupted, but it is also not actively normalized:
+
+- [PyMdown Keys](https://facelessuser.github.io/pymdown-extensions/extensions/keys/) — `++ctrl+alt+del++` (not a markdown construct, preserved as-is)
+- [PyMdown Critic Markup](https://facelessuser.github.io/pymdown-extensions/extensions/critic/) — `{--deleted--}`, `{++added++}`, `{~~old~>new~~}`, `{==highlight==}`, `{>>comment<<}`
+- [PyMdown Highlight](https://facelessuser.github.io/pymdown-extensions/extensions/mark/) — `==marked text==`
+- [PyMdown Caret / Tilde](https://facelessuser.github.io/pymdown-extensions/extensions/caret/) — `H^2^O`, `CH~3~OH`
+- [PyMdown Emoji](https://facelessuser.github.io/pymdown-extensions/extensions/emoji/) — `:smile:`, `:material-icon:`
+- [PyMdown InlineHilite](https://facelessuser.github.io/pymdown-extensions/extensions/inlinehilite/) — language hints inside backtick spans (`:::python code`) are never modified
+- [PyMdown SmartSymbols](https://facelessuser.github.io/pymdown-extensions/extensions/smartsymbols/) — `(c)`, `(tm)`, `--`, `-->` are plain ASCII in source and not touched
+- [PyMdown MagicLink](https://facelessuser.github.io/pymdown-extensions/extensions/magiclink/) — `@username`, `#123` are plain text and pass through
+- [Material Grids](https://squidfunk.github.io/mkdocs-material/reference/grids/) — `<div class="grid cards" markdown>` is an HTML block; content is preserved but markdown inside is not reformatted
+- [Mermaid / Superfences](https://squidfunk.github.io/mkdocs-material/reference/diagrams/) — diagram code inside fenced blocks is never modified
+
+**Note on [PyMdown ProgressBar](https://facelessuser.github.io/pymdown-extensions/extensions/progressbar/)**: The syntax `[=50% "50%"]` resembles an undefined link reference and will be escaped to `\[=50% "50%"\]` by default. Use `--ignore-missing-references` to preserve it, or avoid this extension if you use mdformat without that flag.
+
 See the example test files, [./tests/pre-commit-test.md](https://raw.githubusercontent.com/KyleKing/mdformat-mkdocs/main/tests/pre-commit-test.md) and [./tests/format/fixtures.md](https://raw.githubusercontent.com/KyleKing/mdformat-mkdocs/main/tests/format/fixtures.md)
 
 ## `mdformat` Usage

{mdformat_mkdocs-5.2.0b0 → mdformat_mkdocs-5.2.0b1}/mdformat_mkdocs/__init__.py

@@ -1,7 +1,7 @@
 # ruff: noqa: RUF067
 """An mdformat plugin for `mkdocs`."""
 
-__version__ = "5.2.0b0"
+__version__ = "5.2.0b1"
 
 __plugin_name__ = "mkdocs"
 

{mdformat_mkdocs-5.2.0b0 → mdformat_mkdocs-5.2.0b1}/pyproject.toml

@@ -25,7 +25,7 @@ license-files = ["LICENSE"]
 name = "mdformat_mkdocs"
 readme = "README.md"
 requires-python = ">=3.10.0"
-version = "5.2.0b0"
+version = "5.2.0b1"
 
 [project.entry-points."mdformat.parser_extension"]
 mkdocs = "mdformat_mkdocs"
@@ -56,6 +56,7 @@ recommended-mdsf = [
 ]
 test = [
   "beartype >= 0.21.0",
+  "hypothesis >= 6.100.0",
   "pytest >= 9.0.1",
   "pytest-beartype >= 0.2.0",
   "pytest-cov >= 7.0.0",
@@ -69,7 +70,7 @@ homepage = "https://github.com/kyleking/mdformat-mkdocs"
 
 [tool.commitizen]
 tag_format = "v${version}"
-version = "5.2.0b0"
+version = "5.2.0b1"
 version_files = ["mdformat_mkdocs/__init__.py", "pyproject.toml:^version"]
 
 [tool.mypy]
@@ -183,6 +184,13 @@ isolated_build = true
 requires = ["tox>=4.32.0"]
 skip_missing_interpreters = false
 
+[tool.tox.env.canary]
+basepython = ["py314"]
+changedir = "{tox_root}"
+commands = [["python", "scripts/canary.py", {default = [], extend = true, replace = "posargs"}]]
+description = "Run mdformat --check against real downstream repos. Optionally specify: '-- ruff uv' to test a subset."
+skip_install = false
+
 [tool.tox.env.cz]
 basepython = ["py314"]
 commands = [["cz", "bump", {default = [], extend = true, replace = "posargs"}]]