Welcome to Flask Markdown’s documentation!¶
Flask-Markdown adds support for Markdown to your Flask application. There is little to no documentation for it, but it works just the same as markdown would normally.
All source code can be found at Github
Installation¶
Install the extension with one of the following commands:
$ easy_install Flask-Markdown
or alternatively if you have pip installed:
$ pip install Flask-Markdown
How to Use¶
To use you must construct a Markdown
with your Flask
instance.
from flaskext.markdown import Markdown
Markdown(app)
Then in your template
{% filter markdown %}
Your Markdown
=============
{% endfilter %}
You can also do
{{ mkd|markdown }}
Optionally, you can keep a reference to the Markdown instance and use that
to register custom extensions by calling Markdown.register_extension()
or
decorating the extension class with Markdown.extend()