markdown-it-py

Markdown 解析器，正确地完成。

遵循 CommonMark 规范进行基线解析
可配置的语法：您可以添加新规则，甚至替换现有规则。
可插拔：添加语法扩展以扩展解析器（请参阅插件列表）。
高速（请参阅我们的基准测试）
易于安全配置
Google 可信开源软件成员

这是 markdown-it 及其部分相关插件的 Python 移植版。更多详情请参阅：https://markdown-it-py.readthedocs.io 。

关于 markdown-it 本身，请参阅：

**另请参阅：** markdown-it-pyrs，这是一个实验性的 Rust 绑定，速度更快！

安装

PIP

pip install markdown-it-py[plugins]

或使用 extras

pip install markdown-it-py[linkify,plugins]

Conda

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

或使用 extras

conda install -c conda-forge markdown-it-py linkify-it-py mdit-py-plugins

用法

Python API 用法

使用 markdown-it-py 和自定义配置，带或不带插件和功能，将 markdown 渲染为 HTML：

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('commonmark', {'breaks':True,'html':True})
    .use(front_matter_plugin)
    .use(footnote_plugin)
    .enable('table')
)
text = ("""
---
a: 1
---

a | b
- | -
1 | 2

A footnote [^1]

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

## 要将 HTML 导出到文件，请取消注释以下行：
# from pathlib import Path
# Path("output.html").write_text(html_text)

命令行用法

使用 markdown-it-py 从命令行将 markdown 渲染为 HTML：

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

解析一个或多个 markdown 文件，将每个文件转换为 HTML，然后打印到 stdout

位置参数：
  --stdin        从标准输入读取源 Markdown 文件
  filenames      指定要转换的可选文件列表

可选参数：
  -h, --help     显示此帮助消息并退出
  -v, --version  显示程序版本号并退出

交互式：

  $ markdown-it
  markdown-it-py [version 0.0.0] (interactive)
  键入 Ctrl-D 完成输入，或键入 Ctrl-C 退出。
  >>> # 示例
  ... > markdown *input*
  ...
  <h1>示例</h1>
  <blockquote>
  <p>markdown <em>input</em></p>
  </blockquote>

批量：

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

参考文献 / 致谢

非常感谢 markdown-it 的作者们：

Alex Kocharin github/rlidwka
Vitaly Puzrin github/puzrin

也感谢 John MacFarlane 在 CommonMark 规范和参考实现方面的工作。