Permalink
Browse files

Update docs to cover latest changes.

  • Loading branch information...
playpauseandstop committed Apr 1, 2013
1 parent 5a85029 commit fc58190af4af75d593dbd24097ba8b7778fb1c22
Showing with 28 additions and 1 deletion.
  1. +28 −1 docs/index.rst
View
@@ -74,6 +74,12 @@ are optional.
page, and return its HTML rendering as a unicode string. Defaults to
:func:`~.pygmented_markdown`.
+``FLATPAGES_MARKDOWN_EXTENSIONS``
+ .. versionadded:: 0.4
+
+ List of Markdown extensions to use with default HTML renderer. Defaults to
+ ``['codehilite']``.
+
``FLATPAGES_AUTO_RELOAD``
Wether to reload pages at each request. See :ref:`laziness-and-caching`
for more details. The default is to reload in ``DEBUG`` mode only.
@@ -122,6 +128,25 @@ and in templates:
<link rel="stylesheet" href="{{ url_for('pygments_css') }}">
+Using custom Markdown extensions
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. versionadded:: 0.4
+
+By default, Flask-FlatPages renders flatpage body using `Markdown`_ with
+`Pygments`_ format. This means passing ``['codehilite']`` extensions list to
+``markdown.markdown`` function.
+
+But sometimes you need to customize things, like using another extension or
+disable default approach, this possible by passing special config.
+
+For example, using another extension::
+
+ FLATPAGES_MARKDOWN_EXTENSIONS = ['codehilite', 'headerid']
+
+Or disabling default approach::
+
+ FLATPAGES_MARKDOWN_EXTENSIONS = []
.. _laziness-and-caching:
@@ -220,8 +245,10 @@ Changelog
Version 0.4
~~~~~~~~~~~
-Not released yet.
+Released on 2013-04-01
+* Add ``FLATPAGES_MARKDOWN_EXTENSIONS`` config to setup list of Markdown
+ extensions to use with default HTML renderer.
* Fix a bug with non-ASCII filenames.

0 comments on commit fc58190

Please sign in to comment.