文章目录
- python-markdown2：一个快且完整的 Python Markdown 解析器
- 1、这项目做什么
- 2、安装与使用
- 3、测试与质量
- 4、适合谁用
python-markdown2：一个快且完整的 Python Markdown 解析器
python-markdown2 在 GitHub 上已经拿到 2,816 Star 了。
这是一个纯 Python 实现的 Markdown 到 HTML 转换工具，由 Trent Mick 开发，目标是尽可能贴近原版 Perl Markdown.pl 的行为。
1、这项目做什么
就一件事：把 Markdown 文本转成结构正确的 HTML。
它支持 Python 3.5 及以上版本，同时也兼容 pypy 和 jython。除了核心解析功能，还自带一组叫 extras 的扩展，覆盖语法高亮、表格、脚注、自动链接、目录生成、SmartyPants 引号转换等场景。
和另一个流行的 Python Markdown 库相比，python-markdown2 在启动之初就以更快的解析速度和更准确的输出为卖点。项目 wiki 里有专门的 Performance Notes 和 Testing Notes 页面记录这些数据。
2、安装与使用
安装一条命令搞定：
pipinstallmarkdown2也可以装全量依赖：
pipinstallmarkdown2[all]不想装依赖的话，直接把 lib/markdown2.py 复制到项目目录，单文件就能跑。
作为模块导入：
importmarkdown2 markdown2.markdown("*boo!*")或者先实例化再多次转换：
frommarkdown2importMarkdown markdowner=Markdown()markdowner.convert("*boo!*")markdowner.convert("**boom!**")作为命令行工具：
python-mmarkdown2 foo.md>foo.html使用 extras 扩展也很简单，加参数即可：
python markdown2.py--extrasfootnotes foo.md>foo.html或者在代码里传入列表：
markdown2.markdown("*boo!*",extras=["footnotes"])3、测试与质量
项目维护了一套相当完整的测试用例，覆盖自研的 tm-cases、MarkdownTest、MDTest 等多个测试集。跑测试直接 make test 就行。
对贡献代码也有明确要求：必须通过 PEP8 检查，需要相关测试覆盖，bug 修复必须附带回归测试，整个测试套件不能挂，README 或文档也要同步更新。
4、适合谁用
- 需要在 Python 项目里把 Markdown 转成 HTML 的开发者
- 希望用一个文件搞定 Markdown 解析、不想引入复杂依赖的人
- 对解析速度和输出准确性有一定要求的场景
- 做文档站、博客系统、静态站点生成器，需要可靠 Markdown 后端的工程师
n 解析、不想引入复杂依赖的人
- 对解析速度和输出准确性有一定要求的场景
- 做文档站、博客系统、静态站点生成器，需要可靠 Markdown 后端的工程师
