一个通用的django应用程序,用于将带有特定标记的文本转换为html。
django-markup的Python项目详细描述
Django加价
此应用程序是提供将文本转换为HTML的筛选器的通用方法。
文档可在https://docs.elephant.house/django-markup/
快速启动
从python包索引(pypi)下载并安装包:
$ pip install django-markup
注意,django markup带有一些可以使用的过滤器,但是 诸如markdown或structuredtext之类的复杂包不是代码的一部分。 请参阅用于内置筛选器的包的文档。
另一种方法是安装带有所有过滤器依赖项的django标记 马上。使用:
$ 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 $ pipenv run ./runtests.py
您还可以测试django和python版本的变体 使用毒性:
$ tox
变更日志
v1.4(2019-03-15):
- markdown的安全模式已被弃用,不再起作用,而是行为 已替换为bleach。
- 本地开发和一般代码清理的pipfile支持。
v1.3(2018-09-07):
- python 3.6和3.7兼容性和测试。
- Django 2.0和2.1兼容性和测试。
- 包安装脚本现在提供了安装所有筛选器的能力 自动依赖项。有关详细信息,请参阅安装自述文件。
v1.2(2017-03-18):
- Django 1.10兼容性和测试。
- 已更新所有筛选器依赖项。最著名的Smartypants到2.0版 这改变了它的api,所以您的项目依赖项需要更新它 也。
v1.1(2016-05-02):
- 默认情况下,标记筛选启用了safe_mode选项。
- structuredText筛选器包含文件和原始内容 默认情况下禁用。
v1.0(2016-01-02):
- 去除了一些5年前的灰尘
- Django 1.8+兼容
- 测试
向后不兼容的更改:
- 已删除标记和重新构造文本筛选器中突出显示的pygments。
- 删除了creoleparser库以支持pypi包。
- 已拆下灯箱过滤器。
- structuredText筛选器现在呈现级别1和级别2的标题。 有关详细信息和向后兼容的解决方案,请参见githubIssue 14。
v0.4(2011-06-01):
- 添加了Widont筛选器
- markupfield与南方兼容。
- 用django 1.3进行测试
v0.3(2009-07-29):
django标记现在附带了一个内置的creole解析器。优点是 最近使用的creoleparser库需要genshi库,它需要 一个c编译器等等。内置creole解析器是一个纯python库 没有任何依赖关系,遵循wikicreole.org规范。 django标记使用WikiCreole library。