Ticket #10146: markup_extension_configs_docs.diff

ref/contrib/index.txt

@@ -143 +143 @@
 
 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 django/contrib/markup/templatetags/markup.py.
+a template, and you'll have access to these filters.
+
+For more documentation, read the source code in django/contrib/markup/templatetags/markup.py.
 
 .. _Textile: http://en.wikipedia.org/wiki/Textile_%28markup_language%29
 .. _Markdown: http://en.wikipedia.org/wiki/Markdown
 .. _ReST (ReStructured Text): http://en.wikipedia.org/wiki/ReStructuredText
 
+Markdown
+--------
+
+When using the ``markdown`` markup language you can load `markdown extensions`_ by passing
+them as template parameters:
+
+.. code-block:: html+django
+
+    {{yourtext|markdown:"wikilink,footnotes"}}
+
+You can configure the extensions by defining :setting:`MARKDOWN_FILTER_SETTINGS` in your Django settings.
+For example, when using the wikilink extension you could use the following options:
+
+.. code-block:: python
+
+    MARKDOWN_FILTER_SETTINGS = {
+            'wikilink': [
+                ('base_url', '/help/'),
+                ('end_url', '/'), # append slash after all wiki links
+                ('html_class', 'wikilink') # css class for wiki links
+            ]
+        }
+
+.. _markdown extensions: http://www.freewisdom.org/projects/python-markdown/Extensions
+
+ReStructured Text
+-----------------
+
+When using the `restructuredtext` markup language you can override the restuctured text settings by defining
+:setting:`RESTRUCTUREDTEXT_FILTER_SETTINGS` in your Django settings. See the `restructuredtext settings`_
+for details on what these settings are.
+
+.. _restructuredtext settings: http://docutils.sourceforge.net/docs/user/config.html#html4css1-writer
+
 redirects
 =========