=====================
Django MarkWhat
=====================
.. image:: https://travis-ci.org/Alir3z4/django-markwhat.svg?branch=master
:target: https://travis-ci.org/Alir3z4/django-markwhat
.. contents:: Table of contents
.. note::
Extracted from `Django 1.4 since markup deprecation <https://docs.djangoproject.com/en/dev/releases/1.5/#django-contrib-markup>`_
------
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 3 (3.9, 3.10)
* PyPy
Installation
------------
``django-markwhat-next`` is available on pypi:
https://pypi.org/project/django-markwhat/
Install it by ``pip``:
::
pip install django-markwhat-next
Another way is by cloning ``django-markwhat``'s `git repo <https://github.com/CryoTechnic/django-markwhat-next>`_ :::
git clone git://github.com/CryoTechnic/django-markwhat-next.git
Then install it by running:
::
$ python setup.py install
Configuration
******************
To activate these filters, add ``'django_markwhat_next'`` 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.
.. _Textile: http://en.wikipedia.org/wiki/Textile_%28markup_language%29
.. _Markdown: http://en.wikipedia.org/wiki/Markdown
.. _CommonMark: http://commonmark.org
.. _CommonMark-py: https://pypi.python.org/pypi/CommonMark
.. _reST (reStructured Text): http://en.wikipedia.org/wiki/reStructuredText
.. _PyTextile: http://loopcore.com/python-textile/
.. _Python-markdown: http://pypi.python.org/pypi/Markdown
.. _docutils: http://docutils.sf.net/
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
<http://docutils.sourceforge.net/docs/howto/security.html>`_ documentation.
.. _reStructuredText writer settings: http://docutils.sourceforge.net/docs/user/config.html#html4css1-writer
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
Raw data
{
"_id": null,
"home_page": "https://pypi.org/project/django-markwhat/",
"name": "django-markwhat-next",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "django,markdown,markup,textile,rst,reStructuredText,docutils,commonmark,web",
"author": "Alireza Savand & Ron Friedman",
"author_email": "alireza.savand@gmail.com, rfriedman@lanets.ca",
"download_url": "https://files.pythonhosted.org/packages/4f/79/719f1c52b7d52f81df481302fd8e2e171d0e074e7cd2f487b9b3d37c66c3/django-markwhat-next-1.7.0.tar.gz",
"platform": "OS Independent",
"description": "=====================\nDjango MarkWhat\n=====================\n\n.. image:: https://travis-ci.org/Alir3z4/django-markwhat.svg?branch=master\n :target: https://travis-ci.org/Alir3z4/django-markwhat\n\n\n.. contents:: Table of contents\n\n.. note::\n\n Extracted from `Django 1.4 since markup deprecation <https://docs.djangoproject.com/en/dev/releases/1.5/#django-contrib-markup>`_\n\n------\n\nA collection of template filters that implement common markup languages.\n\nprovides template filters that implement the following markup\nlanguages:\n\n* ``textile`` -- implements `Textile`_ -- requires `PyTextile`_\n* ``markdown`` -- implements `Markdown`_ -- requires `Python-markdown`_\n* ``commonmark`` -- implements `CommonMark`_ -- requires `CommonMark-py`_\n* ``reStructuredText`` -- implements `reStructuredText`_\n -- requires `docutils`_\n\nIn each case, the filter expects formatted markup as a string and\nreturns a string representing the marked-up text. For example, the\n``textile`` filter converts text that is marked-up in Textile format\nto HTML.\n\n\nSupported Python versions\n=========================\n\n``django-crequest`` currently can be run on multiple python versions:\n\n* Python 3 (3.9, 3.10)\n* PyPy\n\n\n\nInstallation\n------------\n``django-markwhat-next`` is available on pypi:\n\nhttps://pypi.org/project/django-markwhat/\n\nInstall it by ``pip``:\n::\n \n pip install django-markwhat-next\n\nAnother way is by cloning ``django-markwhat``'s `git repo <https://github.com/CryoTechnic/django-markwhat-next>`_ :::\n \n git clone git://github.com/CryoTechnic/django-markwhat-next.git\n\nThen install it by running:\n::\n \n $ python setup.py install\n\nConfiguration\n******************\n\nTo activate these filters, add ``'django_markwhat_next'`` to your\n``INSTALLED_APPS`` setting. Once you've done that, use\n``{% load markup %}`` in a template, and you'll have access to these filters.\n\n.. warning::\n\n The output of markup filters is marked \"safe\" and will not be escaped when\n rendered in a template. Always be careful to sanitize your inputs and make\n sure you are not leaving yourself vulnerable to cross-site scripting or\n other types of attacks.\n\n.. _Textile: http://en.wikipedia.org/wiki/Textile_%28markup_language%29\n.. _Markdown: http://en.wikipedia.org/wiki/Markdown\n.. _CommonMark: http://commonmark.org\n.. _CommonMark-py: https://pypi.python.org/pypi/CommonMark\n.. _reST (reStructured Text): http://en.wikipedia.org/wiki/reStructuredText\n.. _PyTextile: http://loopcore.com/python-textile/\n.. _Python-markdown: http://pypi.python.org/pypi/Markdown\n.. _docutils: http://docutils.sf.net/\n\nreStructuredText\n----------------\n\nWhen using the ``reStructuredText`` markup filter you can define a\n`RESTRUCTUREDTEXT_FILTER_SETTINGS` in your django settings to\noverride the default writer settings. See the `reStructuredText writer\nsettings`_ for details on what these settings are.\n\n.. warning::\n\n reStructuredText has features that allow raw HTML to be included, and that\n allow arbitrary files to be included. These can lead to XSS vulnerabilities\n and leaking of private information. It is your responsibility to check the\n features of this library and configure appropriately to avoid this. See the\n `Deploying Docutils Securely\n <http://docutils.sourceforge.net/docs/howto/security.html>`_ documentation.\n\n.. _reStructuredText writer settings: http://docutils.sourceforge.net/docs/user/config.html#html4css1-writer\n\nMarkdown\n--------\n\nThe Python Markdown library supports options named \"safe_mode\" and\n\"enable_attributes\". Both relate to the security of the output. To enable both\noptions in tandem, the markdown filter supports the \"safe\" argument.\n::\n \n {{ markdown_content_var|markdown:\"safe\" }}\n\n.. warning::\n\n Versions of the Python-Markdown library prior to 2.1 do not support the\n optional disabling of attributes and by default\n\nTests\n-----\n\n``django-markwhat`` is tested on both `python2` and `python3`, to run the tests:\n\n::\n\n $ python run_tests.py\n\n\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "A collection of template filters that implement common markup languages.",
"version": "1.7.0",
"project_urls": {
"Homepage": "https://pypi.org/project/django-markwhat/"
},
"split_keywords": [
"django",
"markdown",
"markup",
"textile",
"rst",
"restructuredtext",
"docutils",
"commonmark",
"web"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e38386ca0590037c4015a873ac29775e929e5cc40d28a0e48fbad9ac063453d8",
"md5": "34888c3f23e2bc94c847faa3a3932448",
"sha256": "3be44ecc6da16fd7623b7be15b21d8b909922c237a2d69b1e3d5f8c1ed57d4d5"
},
"downloads": -1,
"filename": "django_markwhat_next-1.7.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "34888c3f23e2bc94c847faa3a3932448",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 8394,
"upload_time": "2023-07-12T07:18:09",
"upload_time_iso_8601": "2023-07-12T07:18:09.057820Z",
"url": "https://files.pythonhosted.org/packages/e3/83/86ca0590037c4015a873ac29775e929e5cc40d28a0e48fbad9ac063453d8/django_markwhat_next-1.7.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4f79719f1c52b7d52f81df481302fd8e2e171d0e074e7cd2f487b9b3d37c66c3",
"md5": "17b60e7fe83bf0bf27696f438dfb21d8",
"sha256": "0ab51dc2a98fd9108ca3f50b5feb8c75a882937b7e9556984e69c5defa640358"
},
"downloads": -1,
"filename": "django-markwhat-next-1.7.0.tar.gz",
"has_sig": false,
"md5_digest": "17b60e7fe83bf0bf27696f438dfb21d8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 8937,
"upload_time": "2023-07-12T07:18:10",
"upload_time_iso_8601": "2023-07-12T07:18:10.653553Z",
"url": "https://files.pythonhosted.org/packages/4f/79/719f1c52b7d52f81df481302fd8e2e171d0e074e7cd2f487b9b3d37c66c3/django-markwhat-next-1.7.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-12 07:18:10",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "django-markwhat-next"
}
JSON