📖 在 https://django-markup.readthedocs.io/en/latest/ 上查看完整文档

django-markup

此应用程序提供了一种通用的方式来提供将文本转换为HTML的过滤器。

兼容性矩阵

快速入门

从python包索引（pypi）下载并安装该包

请注意，django-markup自带了一些可直接使用的过滤器，但更复杂的包（如Markdown或ReStructuredText）不是代码的一部分。请参考文档了解哪些包用于内置过滤器。

另一种选择是立即安装带有所有过滤器依赖项的django-markup。这样做的方式是：

$ pip install django-markup[all_filter_dependencies]

然后将其添加到INSTALLED_APPS列表中

INSTALLED_APPS = (
    ...
    'django_markup',
)

在模板中使用它

{% load markup_tags %}
{{ the_text|apply_markup:"markdown" }}

或在Python代码中使用它

from django_markup.markup import formatter
formatter('Some *Markdown* text.', filter_name='markdown')

测试套件

要运行测试套件，请使用pipenv安装项目并运行它

% pipenv install --dev
$ pipenv run test

您还可以使用tox测试Django和Python版本的不同变体

$ tox

变更日志

v1.9 (2024-08-11)

• 微调了类型注解。
• 从pipenv切换到Poetry。
• 添加了对Django 5.1的支持。

v1.8.1 (2023-10-07)

• 移除对"Self"的所有注解。这需要在Python <3.11的安装上添加额外的依赖，但这不值得。

v1.8 (2023-10-07)

• 停止支持Python <3.8。
• 添加了对Python 3.12和Django 5.0的支持。
• 类型注解。

v1.7.2 (2023-05-01)

• 修复了setup.cfg中的一个bug，该bug将最小Django版本定义为v3.7，这不存在。正确版本是3.2。

v1.7.1 (2023-04-25)

• 修复了setup.cfg中的Python分类器。

v1.7 (2023-04-25)

• 与Django 4.2的兼容性和测试。
• 与Python 3.11的兼容性和测试。

v1.6 (2022-08-14)

• 停止支持Django <3.2和Python <3.7。
• 与Django 3.2 (LTS)的兼容性和测试。
• 与Django 4.0的兼容性和测试。
• 与Django 4.1的兼容性和测试。
• 与Python 3.9的兼容性和测试。
• 与Python 3.10的兼容性和测试。

v1.5 (2020-06-12)

• 停止支持Django <=1.11和Python <=3.5。
• 与Python 3.8的兼容性和测试。
• 与Django 3.0的兼容性和测试。
• 由于标签现在包含在内置的markdown过滤器中，因此不再需要bleach-whitelist依赖项。
• 使用pytest进行测试。

v1.4 (2019-03-15)

• Markdown的safe_mode已被弃用，不再可用，其行为已被bleach取代。
• 支持Pipfile进行本地开发和一般代码清理。

v1.3 (2018-09-07)

• 与Python 3.6和3.7的兼容性和测试。
• 与Django 2.0和2.1的兼容性和测试。
• 包安装脚本现在可以自动安装所有过滤器依赖项。有关详细信息，请参阅安装Readme文件。

v1.2 (2017-03-18)

• 与Django 1.10的兼容性和测试。
• 更新了所有过滤器依赖项，最值得注意的是SmartyPants更新到v2.0，这改变了它的API，因此您的项目依赖项也需要更新。

v1.1 (2016-05-02)

• Markdown过滤器默认启用了safe_mode选项。
• RestructuredText过滤器默认禁用了文件和原始内容包含。

v1.0 (2016-01-02)

• 移除了一些5年前的旧文件。
• Django 1.8+ 兼容
• 测试

向后不兼容的更改

• 从Markdown和RestructuredText过滤器中移除了Pygments高亮显示。
• 移除了CreoleParser库，转而使用pypi包。
• 移除了Lightbox过滤器。
• RestructuredText过滤器现在渲染1级和2级标题。有关详细信息以及向后兼容的解决方案，请参阅GitHub 问题14。

v0.4 (2011-06-01)

• 添加了一个widont过滤器。
• MarkupField与South兼容。
• 与Django 1.3进行了测试。

v0.3 (2009-07-29)

django-markup现在包含一个内置的Creole解析器。优点是，最近使用的Creoleparser库需要Genshi库，这需要一个c编译器等等。内置的Creole解析器是一个纯Python库，没有依赖项，并遵循wikicreole.org规范。django-markup使用WikiCreole库。