🗑 DEPRECATE: Move plugins to mdit_py_plugins (#93)

Plugins (in `markdown_it.extensions`) have now been moved to <https://github.com/executablebooks/mdit-py-plugins>.
This will allow for their maintenance to occur on a different cycle to the core code, facilitating the release of a v1.0.0 for this package

Author: chrisjsewell

.mypy.ini

@@ -3,3 +3,6 @@ warn_unused_ignores = True
 warn_redundant_casts = True
 no_implicit_optional = True
 strict_equality = True
+
+[mypy-tests.test_plugins.*]
+ignore_errors = True

MANIFEST.in

@@ -19,5 +19,5 @@ include LICENSE
 include LICENSE.markdown-it
 include CHANGELOG.md
 
-recursive-exclude markdown_it *.js
-recursive-include markdown_it port.yaml LICENSE README.md py.typed
+include markdown_it/py.typed
+include markdown_it/port.yaml

docs/plugins.md

@@ -7,41 +7,48 @@ The following plugins are embedded within the core package (enabled when using t
 - [tables](https://help.github.com/articles/organizing-information-with-tables/) (GFM)
 - [strikethrough](https://help.github.com/articles/basic-writing-and-formatting-syntax/#styling-text) (GFM)
 
-Other plugins are then available *via* the `markdown_it.extensions` package.
+Other plugins are then available *via* the [`mdit_py_plugins`](https://github.com/executablebooks/mdit-py-plugins).
+
+```{important}
+``markdown_it.extensions`` is now deprecated and plugins have been moved to
+[`mdit_py_plugins`](https://github.com/executablebooks/mdit-py-plugins)
+```
+
 They can be chained and loaded *via*:
 
 ```python
 from markdown_it import MarkdownIt
+from mdit_py_plugins import plugin1, plugin2
 md = MarkdownIt().use(plugin1, keyword=value).use(plugin2, keyword=value)
 html_string = md.render("some *Markdown*")
 ```
 
 ```{eval-rst}
-.. autofunction:: markdown_it.extensions.anchors.anchors_plugin
+.. autofunction:: mdit_py_plugins.anchors.anchors_plugin
     :noindex:
 
-.. autofunction:: markdown_it.extensions.footnote.footnote_plugin
+.. autofunction:: mdit_py_plugins.footnote.footnote_plugin
     :noindex:
 
-.. autofunction:: markdown_it.extensions.front_matter.front_matter_plugin
+.. autofunction:: mdit_py_plugins.front_matter.front_matter_plugin
     :noindex:
 
-.. autofunction:: markdown_it.extensions.container.container_plugin
+.. autofunction:: mdit_py_plugins.container.container_plugin
     :noindex:
 
-.. autofunction:: markdown_it.extensions.deflist.deflist_plugin
+.. autofunction:: mdit_py_plugins.deflist.deflist_plugin
     :noindex:
 
-.. autofunction:: markdown_it.extensions.texmath.texmath_plugin
+.. autofunction:: mdit_py_plugins.texmath.texmath_plugin
     :noindex:
 
-.. autofunction:: markdown_it.extensions.dollarmath.dollarmath_plugin
+.. autofunction:: mdit_py_plugins.dollarmath.dollarmath_plugin
     :noindex:
 
-.. autofunction:: markdown_it.extensions.amsmath.amsmath_plugin
+.. autofunction:: mdit_py_plugins.amsmath.amsmath_plugin
     :noindex:
 
-.. autofunction:: markdown_it.extensions.tasklists.tasklists_plugin
+.. autofunction:: mdit_py_plugins.tasklists.tasklists_plugin
     :noindex:
 ```
 

markdown_it/extensions/amsmath.py

@@ -0,0 +1,9 @@
+from mdit_py_plugins.amsmath import *  # noqa: F401,F403
+
+import warnings
+
+warnings.warn(
+    "`markdown_it.extensions` is deprecated, import from `mdit_py_plugins` instead",
+    DeprecationWarning,
+    stacklevel=2,
+)

markdown_it/extensions/amsmath/__init__.py

@@ -0,0 +1,9 @@
+from mdit_py_plugins.anchors import *  # noqa: F401,F403
+
+import warnings
+
+warnings.warn(
+    "`markdown_it.extensions` is deprecated, import from `mdit_py_plugins` instead",
+    DeprecationWarning,
+    stacklevel=2,
+)