| commit | 042f403e15121ccd213fd75842ed8a57cf4ca623 | [log] [tgz] |
|---|---|---|
| author | Taneli Hukkinen <hukkinj1@users.noreply.github.com> | Wed Nov 25 19:29:43 2020 +0100 |
| committer | GitHub <noreply@github.com> | Wed Nov 25 19:29:43 2020 +0100 |
| tree | 2f9c7c87cf71c214f3e0ca7a7504e9731d7cd9e0 | |
| parent | 9877c0c2d0202662ab34ee30d8c07b0bea1719b8 [diff] |
👌 IMPROVE: Use bool() for conciseness (#83)
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
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)
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.
