Merge branch 'master' into no-attrdict

Author: chrisjsewell

.flake8

@@ -61,10 +61,10 @@ jobs:
     steps:
     - name: Checkout source
       uses: actions/checkout@v2
-    - name: Set up Python 3.7
+    - name: Set up Python
       uses: actions/setup-python@v2
       with:
-        python-version: 3.7
+        python-version: 3.8
     - name: Build package
       run: |
         pip install wheel

.github/workflows/tests.yml

@@ -20,22 +20,37 @@ repos:
     - id: trailing-whitespace
 
   - repo: https://github.com/mgedmin/check-manifest
-    rev: "0.44"
+    rev: "0.46"
     hooks:
     - id: check-manifest
+      args: [--no-build-isolation]
+      additional_dependencies: [setuptools>=46.4.0]
+
+  # this is not used for now,
+  # since it converts mdit-py-plugins to mdit_py_plugins and removes comments
+  # - repo: https://github.com/asottile/setup-cfg-fmt
+  #   rev: v1.17.0
+  #   hooks:
+  #   - id: setup-cfg-fmt
+
+  - repo: https://github.com/timothycrosley/isort
+    rev: 5.8.0
+    hooks:
+    - id: isort
 
   - repo: https://github.com/psf/black
     rev: 20.8b1
     hooks:
     - id: black
 
   - repo: https://gitlab.com/pycqa/flake8
-    rev: 3.8.4
+    rev: 3.9.1
     hooks:
     - id: flake8
+      additional_dependencies: [flake8-bugbear==21.3.1]
 
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v0.790
+    rev: v0.812
     hooks:
     - id: mypy
-      additional_dependencies: [markdown-it-py>=0.6.0]
+      additional_dependencies: [markdown-it-py~=1.0]

.mypy.ini

@@ -0,0 +1,12 @@
+version: 2
+
+python:
+  version: 3
+  install:
+  - method: pip
+    path: .
+    extra_requirements: [rtd]
+
+sphinx:
+  builder: html
+  fail_on_warning: true

.pre-commit-config.yaml

@@ -1,5 +1,18 @@
 # Change Log
 
+## 0.2.8 - 2021-05-03
+
+🐛 FIX: `wordcount` update of minutes
+
+## 0.2.7 - 2021-05-03
+
+- ⬆️ UPDATE: markdown-it-py~=1.0
+- ✨ NEW: Add `wordcount_plugin`
+- 👌 IMPROVE: `dollarmath`: Allow inline double-dollar
+- 👌 IMPROVE: `myst_blocks`: Parse multiline comments
+- 👌 IMPROVE: Replace use of `env` as an `AttrDict`
+- 🐛 FIX: `front_matter`: don't duplicate content storage in `Token.meta`
+
 ## 0.2.6 - 2021-03-17
 
 👌 IMPROVE: Remove direct use of `Token.attrs`

.readthedocs.yml

@@ -1,3 +1,5 @@
+exclude docs
+recursive-exclude docs *
 exclude tests
 recursive-exclude tests *
 

CHANGELOG.md

@@ -0,0 +1,29 @@
+project = "mdit-py-plugins"
+copyright = "2020, Executable Book Project"
+author = "Executable Book Project"
+
+master_doc = "index"
+
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.intersphinx",
+    "myst_parser",
+]
+
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3.8", None),
+    "markdown_it": ("https://markdown-it-py.readthedocs.io/en/latest", None),
+}
+
+html_title = "mdit-py-plugins"
+html_theme = "sphinx_book_theme"
+html_theme_options = {
+    "single_page": True,
+    "use_edit_page_button": True,
+    "repository_url": "https://github.com/executablebooks/mdit-py-plugins",
+    "repository_branch": "master",
+    "path_to_docs": "docs",
+}

MANIFEST.in

@@ -0,0 +1,117 @@
+# Markdown-It-Py Plugin Extensions
+
+## Built-in
+
+The following plugins are embedded within the core package:
+
+- [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)
+
+These can be enabled individually:
+
+```python
+from markdown_it import MarkdownIt
+md = MarkdownIt("commonmark").enable('table')
+```
+
+or as part of a configuration:
+
+```python
+from markdown_it import MarkdownIt
+md = MarkdownIt("gfm-like")
+```
+
+```{seealso}
+See [](markdown_it:using)
+```
+
+## mdit-py-plugins package
+
+The [`mdit_py_plugins`](https://github.com/executablebooks/mdit-py-plugins), contains a number of common 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*")
+```
+
+## Front-Matter
+
+```{eval-rst}
+.. autofunction:: mdit_py_plugins.front_matter.front_matter_plugin
+```
+
+## Footnotes
+
+```{eval-rst}
+.. autofunction:: mdit_py_plugins.footnote.footnote_plugin
+```
+
+## Definition Lists
+
+```{eval-rst}
+.. autofunction:: mdit_py_plugins.deflist.deflist_plugin
+```
+
+## Task lists
+
+```{eval-rst}
+.. autofunction:: mdit_py_plugins.tasklists.tasklists_plugin
+```
+
+## Heading Anchors
+
+```{eval-rst}
+.. autofunction:: mdit_py_plugins.anchors.anchors_plugin
+```
+
+## Word Count
+
+```{eval-rst}
+.. autofunction:: mdit_py_plugins.wordcount.wordcount_plugin
+```
+
+## Containers
+
+```{eval-rst}
+.. autofunction:: mdit_py_plugins.container.container_plugin
+```
+
+## Math
+
+```{eval-rst}
+.. autofunction:: mdit_py_plugins.texmath.texmath_plugin
+```
+
+```{eval-rst}
+.. autofunction:: mdit_py_plugins.dollarmath.dollarmath_plugin
+```
+
+```{eval-rst}
+.. autofunction:: mdit_py_plugins.amsmath.amsmath_plugin
+```
+
+## MyST plugins
+
+`myst_blocks` and `myst_role` plugins are also available, for utilisation by the [MyST renderer](https://myst-parser.readthedocs.io/en/latest/using/syntax.html)
+
+```{eval-rst}
+.. autofunction:: mdit_py_plugins.myst_role.myst_role_plugin
+.. autofunction:: mdit_py_plugins.myst_blocks.myst_block_plugin
+```
+
+## Write your own
+
+Use the `mdit_py_plugins` as a guide to write your own, following the [markdown-it design principles](markdown_it:architecture).
+
+There are many other plugins which could easily be ported from the JS versions (and hopefully will):
+
+- [subscript](https://github.com/markdown-it/markdown-it-sub)
+- [superscript](https://github.com/markdown-it/markdown-it-sup)
+- [abbreviation](https://github.com/markdown-it/markdown-it-abbr)
+- [emoji](https://github.com/markdown-it/markdown-it-emoji)
+- [insert](https://github.com/markdown-it/markdown-it-ins)
+- [mark](https://github.com/markdown-it/markdown-it-mark)
+- ... and [others](https://www.npmjs.org/browse/keyword/markdown-it-plugin)

docs/conf.py

@@ -1 +1 @@
-__version__ = "0.2.6"
+__version__ = "0.2.8"