👌 IMPROVE: Make SyntaxTreeNode type annotations work when subclassing (#131)

This commit makes `SyntaxTreeNode.children` and `SyntaxTreeNode.parent`
`@property` s, so that they can be type annotated
in a way where the getter return type is automatically bound to type of `self`.
1 file changed
tree: 3555d2da628dc5e7948b44d0f6c3b8bf594f7444
  1. .flake8
  2. .github/
  3. .gitignore
  4. .mypy.ini
  5. .pre-commit-config.yaml
  6. .readthedocs.yml
  7. CHANGELOG.md
  8. LICENSE
  9. LICENSE.markdown-it
  10. MANIFEST.in
  11. README.md
  12. benchmarking/
  13. codecov.yml
  14. docs/
  15. docstring.fmt.mustache
  16. markdown_it/
  17. setup.py
  18. tests/
  19. tox.ini
README.md

markdown-it-py

Github-CI Coverage Status PyPI Conda Code style: black PyPI - Downloads

Markdown parser done right.

This is a Python port of markdown-it, and some of its associated plugins. For more details see: https://markdown-it-py.readthedocs.io.

For details on markdown-it itself, see:

Installation

conda install -c conda-forge markdown-it-py

or

pip install markdown-it-py

Usage

Python API Usage

Render markdown to HTML with markdown-it-py and a custom configuration with and without plugins and features:

from markdown_it import MarkdownIt
from markdown_it.extensions.front_matter import front_matter_plugin
from markdown_it.extensions.footnote import footnote_plugin

md = (
    MarkdownIt()
    .use(front_matter_plugin)
    .use(footnote_plugin)
    .disable('image')
    .enable('table')
)
text = ("""
---
a: 1
---

a | b
- | -
1 | 2

A footnote [^1]

[^1]: some details
""")
tokens = md.parse(text)
html_text = md.render(text)

Command-line Usage

Render markdown to HTML with markdown-it-py from the command-line:

usage: markdown-it [-h] [-v] [filenames [filenames ...]]

Parse one or more markdown files, convert each to HTML, and print to stdout

positional arguments:
  filenames      specify an optional list of files to convert

optional arguments:
  -h, --help     show this help message and exit
  -v, --version  show program's version number and exit

Interactive:

  $ markdown-it
  markdown-it-py [version 0.0.0] (interactive)
  Type Ctrl-D to complete input, or Ctrl-C to exit.
  >>> # Example
  ... > markdown *input*
  ...
  <h1>Example</h1>
  <blockquote>
  <p>markdown <em>input</em></p>
  </blockquote>

Batch:

  $ markdown-it README.md README.footer.md > index.html

References / Thanks

Big thanks to the authors of markdown-it:

Also John MacFarlane for his work on the CommonMark spec and reference implementations.