https://github.com/pyx/flask-simplemde

Flask-SimpleMDE - a Flask extension for SimpleMDE
https://github.com/pyx/flask-simplemde

flask flask-extensions markdown-editor simplemde

Last synced: 3 months ago
JSON representation

Flask-SimpleMDE - a Flask extension for SimpleMDE

• Host: GitHub
• URL: https://github.com/pyx/flask-simplemde
• Owner: pyx
• License: other
• Created: 2016-03-04T07:47:10.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2016-03-28T16:27:24.000Z (almost 9 years ago)
• Last Synced: 2024-09-27T03:08:44.585Z (4 months ago)
• Topics: flask, flask-extensions, markdown-editor, simplemde
• Language: Python
• Homepage:
• Size: 117 KB
• Stars: 24
• Watchers: 3
• Forks: 2
• Open Issues: 3
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
=================================================

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

===========

0. Installation

  .. code-block:: sh

    pip install Flask-SimpleMDE

1. 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)

2. In :code:`templates/hello.html`:

  .. code-block:: jinja

    

    

      

        

        Flask-SimpleMDE example

        {{ simplemde.css }}

        {{ simplemde.js }}

      

      

        

        Some Markdown Text Here

        

        {{ simplemde.load }}

      

    

3. Profit!

How It Works

============

Once registered, this extension provides a template variable called

:code:`simplemde`, it has:

- a property named :code:`css` that will be rendered as HTML :code:`` 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:`js` that will be rendered as HTML :code:``

  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:`load` that 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_id` that 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:`id` attribute

  .. code-block:: jinja

     <textarea id="editor"></textarea>

     ...

     {{ 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>`_