djangofrdoc / ref / contrib / markup.txt


.. module:: django.contrib.markup
   :synopsis: A collection of template filters that implement common markup languages.

Django provides template filters that implement the following markup

    * ``textile`` -- implements `Textile`_ -- requires `PyTextile`_
    * ``markdown`` -- implements `Markdown`_ -- requires `Python-markdown`_
    * ``restructuredtext`` -- implements `reST (reStructured Text)`_
      -- requires `doc-utils`_

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.

To activate these filters, add ``'django.contrib.markup'`` to your
:setting:`INSTALLED_APPS` setting. Once you've done that, use
``{% load markup %}`` in a template, and you'll have access to these filters.
For more documentation, read the source code in

.. 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:
.. _Markdown:
.. _reST (reStructured Text):
.. _PyTextile:
.. _Python-markdown:
.. _doc-utils:

reStructured Text

When using the ``restructuredtext`` markup filter you can define a
:setting:`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.

.. _restructuredtext writer settings: