跳转到主要内容

为django CMS添加片段插件。

项目描述

pypi coverage python django djangocms

django CMS 模块django CMS 提供了一个插件,可以将 HTML、CSS 或 JavaScript 模块注入到您的网站中。

本项目得到 django CMS 协会 的认可。加入我们吧,在 Slack 上一起交流。

注意:我们建议仅在开发过程中使用此插件

This plugin is a potential security hazard, since it allows authorized-
users to place custom markup or Javascript on pages bypassing all of
Django's normal sanitization mechanisms. This could be exploited by users
with the right to add snippets to elevate their privileges to superusers.
This plugin should only be used during the initial development phase for
rapid prototyping and testing.
preview.gif

为该项目贡献力量,赢取奖励

因为这是一个开源项目,我们欢迎每个人 参与项目因贡献获得奖励。成为这个优秀社区的一员,帮助我们打造世界上最好的 CMS。

我们非常乐意接收您的反馈,形式为问题和拉取请求。在提交拉取请求之前,请查阅我们的 贡献指南

我们感谢所有帮助创建和维护此软件包的贡献者。贡献者名单在 贡献者 部分列出。

您可以通过在 Transifex 上帮助翻译此插件来做出最简单的贡献之一。

文档

setup.py 文件中查看 REQUIREMENTS 以获取其他依赖项。

安装

对于手动安装

  • 运行 pip install djangocms-snippet

  • djangocms_snippet 添加到您的 INSTALLED_APPS

  • 运行 python manage.py migrate djangocms_snippet

Djangocms-snippet 使用 ace 代码编辑器,通常从 CDN 加载。如果您希望应用程序在本地提供编辑器,可以将要求从 djangocms_snippet 更改为 djangocms_snippet[static-ace] 并将 djangocms_static_ace 添加到项目的 INSTALLED_APPS

配置

要允许搜索所有模块的内容,请将 DJANGOCMS_SNIPPET_SEARCH 设置为 True 在您的设置中

DJANGOCMS_SNIPPET_SEARCH = True

我们选择 Ace 作为编辑器来编辑模块内容。您可以通过以下方式自定义 主题模式

DJANGOCMS_SNIPPET_THEME = 'github'
DJANGOCMS_SNIPPET_MODE = 'html'

如果插入动态内容(例如 {% show_menu ... %}),则必须禁用插件缓存,请在您的设置中将 DJANGOCMS_SNIPPET_CACHE 设置为 False

DJANGOCMS_SNIPPET_CACHE = False # default value is False

模板标签

您还可以使用模板标签来渲染一个模块而不是插件

{% load snippet_tags %}
{% snippet_fragment [reference] %}

[reference] 替换为以下之一

  • 模块 ID,例如 {% snippet_fragment 42 %}

  • 模块别名,例如 {% snippet_fragment 'my-snippet' %}

  • 模块实例,例如 {% snippet_fragment instance.snippet %}

可选地提供如果没有匹配的 id/slug/实例时的回退

{% snippet_fragment 'my-snippet' or %}
    ... your content fallback here ...
{% endsnippet_fragment %}

运行测试

您可以通过执行以下操作来运行测试

virtualenv env
source env/bin/activate
pip install -r tests/requirements.txt
python setup.py test

项目详情


下载文件

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

源代码分发

djangocms-snippet-3.1.1.tar.gz (34.6 kB 查看哈希值)

上传时间 源代码

构建分发

djangocms_snippet-3.1.1-py3-none-any.whl (138.4 kB 查看哈希值)

上传时间 Python 3

由支持