A collection of template filters that implement common markup languages.
Project description
Table of contents
Note
Extracted from Django 1.4 since markup deprecation
A collection of template filters that implement common markup languages.
provides template filters that implement the following markup languages:
- textile – implements Textile – requires PyTextile
- markdown – implements Markdown – requires Python-markdown
- commonmark – implements CommonMark – requires CommonMark-py
- reStructuredText – implements reStructuredText – requires docutils
In each case, the filter expects formatted markup as a string and returns a string representing the marked-up text. For example, the textile filter converts text that is marked-up in Textile format to HTML.
Supported Python versions
django-crequest currently can be run on multiple python versions:
- Python 2 (2.7)
- Python 3 (3.5, 3.6)
- PyPy
Installation
django-markwhat is available on pypi:
http://pypi.python.org/pypi/django-markwhat
So easily install it by pip:
pip install django-markwhat
Or by easy_install
$ easy_install django-markwhat
Another way is by cloning django-markwhat’s git repo ::
git clone git://github.com/Alir3z4/django-markwhat.git
Then install it by running:
$ python setup.py install
Configuration
To activate these filters, add 'django_markwhat' to your INSTALLED_APPS setting. Once you’ve done that, use {% load markup %} in a template, and you’ll have access to these filters.
Warning
The output of markup filters is marked “safe” and will not be escaped when rendered in a template. Always be careful to sanitize your inputs and make sure you are not leaving yourself vulnerable to cross-site scripting or other types of attacks.
reStructuredText
When using the reStructuredText markup filter you can define a RESTRUCTUREDTEXT_FILTER_SETTINGS in your django settings to override the default writer settings. See the reStructuredText writer settings for details on what these settings are.
Warning
reStructuredText has features that allow raw HTML to be included, and that allow arbitrary files to be included. These can lead to XSS vulnerabilities and leaking of private information. It is your responsibility to check the features of this library and configure appropriately to avoid this. See the Deploying Docutils Securely documentation.
Markdown
The Python Markdown library supports options named “safe_mode” and “enable_attributes”. Both relate to the security of the output. To enable both options in tandem, the markdown filter supports the “safe” argument.
{{ markdown_content_var|markdown:"safe" }}
Warning
Versions of the Python-Markdown library prior to 2.1 do not support the optional disabling of attributes and by default
Tests
django-markwhat is tested on both python2 and python3, to run the tests:
$ python run_tests.py
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Filename, size | File type | Python version | Upload date | Hashes |
---|---|---|---|---|
Filename, size django_markwhat-1.6.2-py2.py3-none-any.whl (8.2 kB) | File type Wheel | Python version py2.py3 | Upload date | Hashes View |
Filename, size django-markwhat-1.6.2.tar.gz (8.1 kB) | File type Source | Python version None | Upload date | Hashes View |
Hashes for django_markwhat-1.6.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ade3b57d8620f13152642399129c7014fd7573be2dafff07f687017e5b6ecff0 |
|
MD5 | 79177884fa19288fd86b5a05f5d05aa8 |
|
BLAKE2-256 | 1dee1d5290b13b62d71485c1bf9797e089a340374b11aacb7b60ae4076aeb6b7 |