Metadata-Version: 1.1
Name: Flask-SimpleMDE
Version: 0.1
Summary: Flask-SimpleMDE - a Flask extension for SimpleMDE
Home-page: https://github.com/pyx/flask-simplemde/
Author: Philip Xu
Author-email: pyx@xrefactor.com
License: BSD-New
Description: =================================================
        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.ext.simplemde import SimpleMDE
        
            app = Flask(__name__)
            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
        
            <!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>
        
        
        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:`<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:`js` that 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:`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>`_
        
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Software Development :: Libraries :: Python Modules
