| commit | 4e6c0abc47552b15655dae89bc16a7d518ea9bd0 | [log] [tgz] |
|---|---|---|
| author | Chris Sewell <chrisj_sewell@hotmail.com> | Tue May 04 00:02:06 2021 +0200 |
| committer | Chris Sewell <chrisj_sewell@hotmail.com> | Tue May 04 00:02:06 2021 +0200 |
| tree | d0b14b9c1d3647597816811ef562d04673647373 | |
| parent | 99bc1ae8c6029b77a0b13749b34f4078fe0dc7d4 [diff] |
🔧 MAINTAIN: Change development status
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:
conda install -c conda-forge markdown-it-py
or
pip install markdown-it-py[plugins]
or with extras
conda install -c conda-forge markdown-it-py linkify-it-py mdit-py-plugins pip install markdown-it-py[linkify,plugins]
Render markdown to HTML with markdown-it-py and a custom configuration with and without plugins and features:
from markdown_it import MarkdownIt from mdit_py_plugins.front_matter import front_matter_plugin from mdit_py_plugins.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) ## To export the html to a file, uncomment the lines below: # from pathlib import Path # Path("output.html").write_text(html_text)
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
Big thanks to the authors of markdown-it:
Also John MacFarlane for his work on the CommonMark spec and reference implementations.
