flask-simplemde
flask-simplemde copied to clipboard
pyx
Flask-SimpleMDE - a Flask extension for SimpleMDE
================================================= Flask-SimpleMDE - a Flask extension for SimpleMDE
Flask-SimpleMDE is an extension to Flask_ that helps integrate SimpleMDE Markdown Editor_ to your Flask application.
.. _Flask: http://flask.pocoo.org/ .. _SimpleMDE Markdown Editor: https://simplemde.com/
Quick Start
- Installation
.. code-block:: sh
pip install Flask-SimpleMDE
- Configuration
.. code-block:: python
from flask import Flask, render_template
from flask_simplemde import SimpleMDE
app = Flask(__name__)
app.config['SIMPLEMDE_JS_IIFE'] = True
app.config['SIMPLEMDE_USE_CDN'] = True
SimpleMDE(app)
@app.route('/')
def hello():
return render_template('hello.html')
if __name__ == '__main__':
app.run(debug=True)
- In :code:
templates/hello.html:
.. code-block:: jinja
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Flask-SimpleMDE example</title>
{{ simplemde.css }}
{{ simplemde.js }}
</head>
<body>
<textarea>
Some Markdown Text Here
</textarea>
{{ simplemde.load }}
</body>
</html>
- Profit!
How It Works
Once registered, this extension provides a template variable called
:code:simplemde, it has:
-
a property named :code:
cssthat will be rendered as HTML :code:<link>tag to the SimpleMDE stylesheet either from free CDN or be served from a bundled blueprint, also called :code:simplemde... code-block:: jinja
{{ simplemde.css }}
-
a property named :code:
jsthat will be rendered as HTML :code:<script>tag to the SimpleMDE javascript either from free CDN or be served from a bundled blueprint, also called :code:simplemde... code-block:: jinja
{{ simplemde.js }}
-
a property named :code:
loadthat will be rendered as HTML :code:<script>tag with javascript code that loads the SimpleMDE Markdown Editor with the first :code:<textarea>tag... code-block:: jinja
{{ simplemde.load }}
-
a method named :code:
load_idthat when called with a string, will be rendered as HTML :code:<script>tag with javascript code that loads the SimpleMDE Markdown Editor with the :code:<textarea>tag which has the specified :code:idattribute.. code-block:: jinja
... {{ simplemde.load_id("editor") }}
License
BSD New, see LICENSE for details.
Links
-
Documentation <http://flask-simplemde.readthedocs.org/>_ -
Issue Tracker <https://github.com/pyx/flask-simplemde/issues/>_ -
Source Package @ PyPI <https://pypi.python.org/pypi/Flask-SimpleMDE/>_ -
Mercurial Repository @ bitbucket <https://bitbucket.org/pyx/flask-simplemde/>_ -
Git Repository @ Github <https://github.com/pyx/flask-simplemde/>_ -
Git Repository @ Gitlab <https://gitlab.com/pyx/flask-simplemde/>_ -
Development Version <http://github.com/pyx/flask-simplemde/zipball/master#egg=Flask-SimpleMDE-dev>_
pyx