Skip to main content

MD4C 的 Python 绑定

项目描述

发布状态 测试状态

PyMD4C

用于非常快速的MD4C Markdown 解析和渲染库的 Python 绑定(加上附加功能) 。

概述

MD4C C 库提供了一个类似SAX 的解析器,它使用回调返回它从 Markdown 输入解析的各种块、内联和文本。此外,它还提供了一个构建在解析器之上的 HTML 渲染器,以直接提供 HTML 输出。

PyMD4C 为两者提供 Python 绑定,以及一些构建在上面的便利功能。目标是为只需要将 Markdown 转换为 HTML 的应用程序提供一个简单快速的界面,同时为需要做更多事情的应用程序提供灵活性。

下面是简要的安装说明和示例,但有关更多详细信息,请参阅完整文档

从 PyPI 安装

PyMD4C 在 PyPI 上可用,名称为pymd4c. 像安装任何其他 Python 包一样使用 pip 安装它:

pip install pymd4c

这是获取 PyMD4C 的推荐方法。它应该在大多数 Linux 发行版、Windows 和 macOS 上运行良好,但由于它包含一个 C 模块,因此必须专门为每个平台构建它。那些在不常见的架构或旧版本的操作系统上运行的人可能会发现预建模块不可用。(如果构建不可用或不适用于您的平台并且您认为它应该可用,请考虑打开GitHub 问题。)

有关更详细的安装说明,包括从源代码构建(几乎适用于任何平台),请参阅完整文档中的“安装”页面。

基本用法

安装 PyMD4C 后,从 Markdown 生成 HTML 非常简单,如下所示:

import md4c

with open('README.md', 'r') as f:
    markdown = f.read()

renderer = md4c.HTMLRenderer()
html = renderer.parse(markdown)

这只是让您尽快启动和运行的最基本示例。有几个选项可用于自定义 MD4C 的解析和 HTML 生成行为,以及用于生成 HTML 之外的其他任务的 API。完整的文档介绍了所有这些功能。

贡献

感谢您有兴趣为 PyMD4C 做出贡献!文档中的“Contributing to PyMD4C”页面包含一些应该证明有用的信息。

执照

该项目在 MIT 许可下获得许可。有关详细信息,请参阅LICENSE.md文件。

项目详情


下载文件

下载适用于您平台的文件。如果您不确定要选择哪个,请了解有关安装包的更多信息。

源分布

pymd4c-1.1.2.tar.gz (51.4 kB 查看哈希

已上传 source

内置发行版

pymd4c-1.1.2-cp310-cp310-win_amd64.whl (89.1 kB 查看哈希

已上传 cp310

pymd4c-1.1.2-cp310-cp310-macosx_10_14_x86_64.whl (30.9 kB 查看哈希

已上传 cp310

pymd4c-1.1.2-cp39-cp39-win_amd64.whl (89.1 kB 查看哈希

已上传 cp39

pymd4c-1.1.2-cp39-cp39-macosx_10_14_x86_64.whl (30.9 kB 查看哈希

已上传 cp39

pymd4c-1.1.2-cp38-cp38-win_amd64.whl (89.1 kB 查看哈希

已上传 cp38

pymd4c-1.1.2-cp38-cp38-macosx_10_14_x86_64.whl (30.9 kB 查看哈希

已上传 cp38

pymd4c-1.1.2-cp37-cp37m-win_amd64.whl (89.0 kB 查看哈希

已上传 cp37

pymd4c-1.1.2-cp37-cp37m-macosx_10_14_x86_64.whl (31.0 kB 查看哈希

已上传 cp37

pymd4c-1.1.2-cp36-cp36m-win_amd64.whl (89.0 kB 查看哈希

已上传 cp36

pymd4c-1.1.2-cp36-cp36m-macosx_10_14_x86_64.whl (31.0 kB 查看哈希

已上传 cp36