Skip to main content

Adds snippet plugin to django CMS.

Project description

pypi build coverage

django CMS Snippet provides a plugin for django CMS to inject HTML, CSS or JavaScript snippets into your website.

This addon is compatible with Divio Cloud and is also available on the django CMS Marketplace for easy installation.

We recommend using this plugin only during development:

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.


This is a an open-source project. We’ll be delighted to receive your feedback in the form of issues and pull requests. Before submitting your pull request, please review our contribution guidelines.

We’re grateful to all contributors who have helped create and maintain this package. Contributors are listed at the contributors section.

One of the easiest contributions you can make is helping to translate this addon on Transifex.


See REQUIREMENTS in the file for additional dependencies:

python django djangocms


For a manual install:

  • run pip install djangocms-snippet
  • add djangocms_snippet to your INSTALLED_APPS
  • run python migrate djangocms_snippet


To allow the contents of all snippets to be searchable, please set DJANGOCMS_SNIPPET_SEARCH to True in your settings:


We are using Ace as our editor of choice to edit the snippet content. You can customize the theme and mode through:


If dynamic content is inserted (for example {% show_menu ... %}), the plugin cache must be disabled, please set DJANGOCMS_SNIPPET_CACHE to False in your settings:

DJANGOCMS_SNIPPET_CACHE = False # default value is True

Template tag

You can also use a template tag to render a snippet rather than a plugin:

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

Replace [reference] with either:

  • The snippet ID, e.g. {% snippet_fragment 42 %}
  • The snippet slug, e.g. {% snippet_fragment 'my-snippet' %}
  • The snippet instance, e.g. {% snippet_fragment instance.snippet %}

Optionally provide a fallback if there is no matching id/slug/instance:

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

Running Tests

You can run tests by executing:

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

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for djangocms-snippet, version 3.0.0
Filename, size File type Python version Upload date Hashes
Filename, size djangocms_snippet-3.0.0-py3-none-any.whl (140.6 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size djangocms-snippet-3.0.0.tar.gz (34.7 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page