├── .github
    └── workflows
    │   └── tests.yml
├── .gitignore
├── CHANGES.md
├── LICENSE
├── MANIFEST.in
├── README.md
├── example
    ├── app.py
    ├── requirements.txt
    └── templates
    │   └── index.html
├── pyproject.toml
├── src
    └── flask_pagedown
    │   ├── __init__.py
    │   ├── fields.py
    │   └── widgets.py
└── tox.ini


/.github/workflows/tests.yml:
--------------------------------------------------------------------------------
 1 | name: build
 2 | on:
 3 |   push:
 4 |     branches:
 5 |       - main
 6 |   pull_request:
 7 |     branches:
 8 |       - main
 9 | jobs:
10 |   lint:
11 |     name: lint
12 |     runs-on: ubuntu-latest
13 |     steps:
14 |       - uses: actions/checkout@v3
15 |       - uses: actions/setup-python@v3
16 |       - run: python -m pip install --upgrade pip wheel
17 |       - run: pip install tox tox-gh-actions
18 |       - run: tox -eflake8
19 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
 1 | *.py[cod]
 2 | 
 3 | # C extensions
 4 | *.so
 5 | 
 6 | # Packages
 7 | *.egg
 8 | *.egg-info
 9 | dist
10 | build
11 | eggs
12 | parts
13 | bin
14 | var
15 | sdist
16 | develop-eggs
17 | .installed.cfg
18 | lib
19 | lib64
20 | __pycache__
21 | 
22 | # Installer logs
23 | pip-log.txt
24 | 
25 | # Unit test / coverage reports
26 | .coverage
27 | .tox
28 | nosetests.xml
29 | 
30 | # Translations
31 | *.mo
32 | 
33 | # Mr Developer
34 | .mr.developer.cfg
35 | .project
36 | .pydevproject
37 | 
38 | venv
39 | 


--------------------------------------------------------------------------------
/CHANGES.md:
--------------------------------------------------------------------------------
 1 | # Flask-PageDown Change Log
 2 | 
 3 | **Release 0.4.0** - 2021-09-08
 4 | 
 5 | - Fix deprecation warnings by using markupsafe.Markup [#27](https://github.com/miguelgrinberg/flask-pagedown/issues/27) ([commit](https://github.com/miguelgrinberg/flask-pagedown/commit/b0bf84f7757f975bef075faab24a6bf11ba02829)) (thanks **Nick Bautista**!)
 6 | - Document how to use your own PageDown JavaScript source files [#24](https://github.com/miguelgrinberg/flask-pagedown/issues/24) ([commit](https://github.com/miguelgrinberg/flask-pagedown/commit/f13f81a72d2dfd0f881306ddc18d5d6642c5744d)) (thanks **olumidesan**!)
 7 | - Improved project structure ([commit](https://github.com/miguelgrinberg/flask-pagedown/commit/ea12a8551b4e17fc7a8adffb26845abbead82b72))
 8 | - Add a change log ([commit](https://github.com/miguelgrinberg/flask-pagedown/commit/a00e7195b1b98008c33cf9c4fafcd5b66026ceb5))
 9 | - Added github actions build ([commit](https://github.com/miguelgrinberg/flask-pagedown/commit/4fec2e7f04c4013193a542218d852072b20bf528))
10 | 
11 | **Release 0.3.0** - 2020-05-02
12 | 
13 | - Converted strings to markup [#21](https://github.com/miguelgrinberg/flask-pagedown/issues/21) ([commit](https://github.com/miguelgrinberg/flask-pagedown/commit/90139d9b45aa1a74adbf4ce221faabf8f9b2ca4f)) (thanks **Petr Deriabin**!)
14 | 
15 | **Release 0.2.2** - 2016-09-30
16 | 
17 | - Updated Form to FlaskForm ([commit](https://github.com/miguelgrinberg/flask-pagedown/commit/fc69896717eea1ebd055c70511a144aee71525f7))
18 | - Updated requirements for example app ([commit](https://github.com/miguelgrinberg/flask-pagedown/commit/5b0f452200cd382aa64c7c5fdadcb7bfcfa29d73))
19 | 
20 | **Release 0.2.1** - 2015-05-11
21 | 
22 | - Support custom CSS classes in field render call ([commit](https://github.com/miguelgrinberg/flask-pagedown/commit/3ee04376a20a7e430190d016a41695c464970201))
23 | 
24 | **Release 0.2.0** - 2015-05-11
25 | 
26 | - Change Flask plugins to new recommended import syntax ([commit](https://github.com/miguelgrinberg/flask-pagedown/commit/c70899a0cc3c23d69cb280177e8dc98cd88fc5b7))
27 | - Render preview separately from input area ([commit](https://github.com/miguelgrinberg/flask-pagedown/commit/69a243900a49baca336040cf0ed73094f7d9f66d))
28 | - pep8 fixes ([commit](https://github.com/miguelgrinberg/flask-pagedown/commit/5b04c2de0e6ad697c0399cd40a59f3709fd33944))
29 | 
30 | **Release 0.1.5** - 2014-05-26
31 | 
32 | - Fix support for SSL for proxied sites, or otherwise uncertain situations My particular situation is deployed through ElasticBeanstalk, proxying HTTPS to HTTP on the actual endpoints. This makes flask think that it is only running with http, not https ([commit](https://github.com/miguelgrinberg/flask-pagedown/commit/04df5c189d6d1760c692d1985faf558058e56eb2)) (thanks **Frank Tackitt**!)
33 | 
34 | **Release 0.1.4** - 2014-02-13
35 | 
36 | - Use of secure URLs when request is secure [#3](https://github.com/miguelgrinberg/flask-pagedown/issues/3) ([commit](https://github.com/miguelgrinberg/flask-pagedown/commit/50ba142994e47d584f5bdf083e0c47f4a9209aa4))
37 | 
38 | **Release 0.1.3** - 2014-01-07
39 | 
40 | - Add check if the document is already ready, and if so skip the onload handlers. Fixes live loading of markdown forms ([commit](https://github.com/miguelgrinberg/flask-pagedown/commit/868a4c51028e580fd265d428a9d8f2afe3f4aa7c)) (thanks **Frank Tackitt**!)
41 | 
42 | **Release 0.1.2** - 2013-11-11
43 | 
44 | - Minor updates ([commit](https://github.com/miguelgrinberg/flask-pagedown/commit/be1a3e4f25f552178e36d7f383783ff192685832))
45 | 
46 | **Release 0.1.1** - 2013-11-05
47 | 
48 | - Fixed setup.py and minor corrections to example app ([commit](https://github.com/miguelgrinberg/flask-pagedown/commit/b50acac4b14f1a882f7de0d47702a175dabde9dc))
49 | 
50 | **Release 0.1** - 2013-11-04
51 | 
52 | - Initial version ([commit](https://github.com/miguelgrinberg/flask-pagedown/commit/d8a30b86354b264c4427424d444140bc9f568116))
53 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | The MIT License (MIT)
 2 | 
 3 | Copyright (c) 2013 Miguel Grinberg
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy of
 6 | this software and associated documentation files (the "Software"), to deal in
 7 | the Software without restriction, including without limitation the rights to
 8 | use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 9 | the Software, and to permit persons to whom the Software is furnished to do so,
10 | subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
17 | FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
18 | COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
19 | IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
20 | CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
21 | 


--------------------------------------------------------------------------------
/MANIFEST.in:
--------------------------------------------------------------------------------
1 | include README.md LICENSE tox.ini
2 | recursive-include docs *
3 | recursive-exclude docs/_build *
4 | recursive-include tests *
5 | exclude **/*.pyc
6 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | Flask-PageDown
  2 | ==============
  3 | 
  4 | [![Build status](https://github.com/miguelgrinberg/Flask-PageDown/workflows/build/badge.svg)](https://github.com/miguelgrinberg/Flask-PageDown/actions)
  5 | 
  6 | Implementation of StackOverflow's "PageDown" markdown editor for Flask and Flask-WTF.
  7 | 
  8 | What is PageDown?
  9 | -----------------
 10 | 
 11 | [PageDown](https://code.google.com/p/pagedown/wiki/PageDown) is the JavaScript [Markdown](http://daringfireball.net/projects/markdown/) previewer used on [Stack Overflow](http://stackoverflow.com/) and all the other question and answer sites in the [Stack Exchange network](http://stackexchange.com/).
 12 | 
 13 | Flask-PageDown provides a `PageDownField` class that extends [Flask-WTF](https://flask-wtf.readthedocs.org/en/latest/) with a specialized text area field that renders an HTML preview of the Markdown text on the fly as you type.
 14 | 
 15 | Installation
 16 | ------------
 17 | 
 18 |     $ pip install flask-pagedown
 19 | 
 20 | Example
 21 | -------
 22 | 
 23 | An example is worth a thousand words. Below is how to define a simple Flask-WTF form that includes a PageDown field:
 24 | 
 25 |     from flask_wtf import Form
 26 |     from flask_pagedown.fields import PageDownField
 27 |     from wtforms.fields import SubmitField
 28 |     
 29 |     class PageDownFormExample(Form):
 30 |         pagedown = PageDownField('Enter your markdown')
 31 |         submit = SubmitField('Submit')
 32 | 
 33 | The `PageDownField` works exactly like a `TextAreaField` (in fact it is a subclass of it). The handling in view functions is identical. For example:
 34 | 
 35 |     @app.route('/', methods = ['GET', 'POST'])
 36 |     def index():
 37 |         form = PageDownFormExample()
 38 |         if form.validate_on_submit():
 39 |             text = form.pagedown.data
 40 |             # do something interesting with the Markdown text
 41 |         return render_template('index.html', form = form)
 42 | 
 43 | The extension needs to be initialized in the usual way before it can be used:
 44 | 
 45 |     from flask_pagedown import PageDown
 46 |     
 47 |     app = Flask(__name__)
 48 |     pagedown = PageDown(app)
 49 | 
 50 | Finally, the template needs the support Javascript code added, by calling `pagedown.include_pagedown()` somewhere in the page:
 51 | 
 52 |     <html>
 53 |     <head>
 54 |     {{ pagedown.include_pagedown() }}
 55 |     </head>
 56 |     <body>
 57 |         <form method="POST">
 58 |             {{ form.hidden_tag() }}
 59 |             {{ form.pagedown(rows=10) }}
 60 |             {{ form.submit }}
 61 |         </form>
 62 |     </body>
 63 |     </html>
 64 | 
 65 | The Javascript classes are imported from a CDN, there are no static files that need to be served by the application. If the request is secure then the Javascript files are imported from an https:// URL to match.
 66 | 
 67 | If you prefer to use your own JavaScript source files, you can simply include your Converter and Sanitizer files directly in the HTML page instead of calling `pagedown.include_pagedown()`:
 68 | 
 69 |     <html>
 70 |     <head>
 71 |         <script type="text/javascript" src="https://mycdn/path/to/converter.min.js"></script>
 72 |         <script type="text/javascript" src="https://mycdn/path/to/sanitizer.min.js"></script>
 73 |     </head>
 74 |     <body>
 75 |         <form method="POST">
 76 |             {{ form.hidden_tag() }}
 77 |             {{ form.pagedown(rows=10) }}
 78 |             {{ form.submit }}
 79 |         </form>
 80 |     </body>
 81 |     </html>
 82 | 
 83 | To help adding specific CSS styling the `<textarea>` element has class `flask-pagedown-input` and the preview `<div>` has class `flask-pagedown-preview`.
 84 | 
 85 | With the template above, the preview area is created by the extension right below the input text area. For greater control, it is also possible to render the input and preview areas on different parts of the page. The following example shows how to render the preview area above the input area:
 86 | 
 87 |     <html>
 88 |     <head>
 89 |     {{ pagedown.include_pagedown() }}
 90 |     </head>
 91 |     <body>
 92 |         <form method="POST">
 93 |             {{ form.pagedown(only_preview=True) }}
 94 |             {{ form.pagedown(only_input=True, rows=10) }}
 95 |             {{ form.submit }}
 96 |         </form>
 97 |     </body>
 98 |     </html>
 99 | 
100 | Note that in all cases the submitted text will be the raw Markdown text. The rendered HTML is only used for the preview, if you need to render to HTML in the server then use a server side Markdown renderer like [Flask-Markdown](http://pythonhosted.org/Flask-Markdown/).
101 | 
102 | Also note that the current version does not include a toolbar like the one used by Stack Overflow.
103 | 
104 | ## Resources
105 | 
106 | - [PyPI](https://pypi.python.org/pypi/flask-pagedown)
107 | - [Change Log](https://github.com/miguelgrinberg/flask-pagedown/blob/main/CHANGES.md)
108 | 
109 | 


--------------------------------------------------------------------------------
/example/app.py:
--------------------------------------------------------------------------------
 1 | from flask import Flask, render_template
 2 | from flask_wtf import FlaskForm
 3 | from flask_pagedown import PageDown
 4 | from flask_pagedown.fields import PageDownField
 5 | from wtforms.fields import SubmitField
 6 | 
 7 | app = Flask(__name__)
 8 | app.config['SECRET_KEY'] = 'secret!'
 9 | pagedown = PageDown(app)
10 | 
11 | 
12 | class PageDownFormExample(FlaskForm):
13 |     pagedown = PageDownField('Enter your markdown')
14 |     pagedown2 = PageDownField('Enter your markdown')
15 |     submit = SubmitField('Submit')
16 | 
17 | 
18 | @app.route('/', methods=['GET', 'POST'])
19 | def index():
20 |     form = PageDownFormExample()
21 |     text = None
22 |     text2 = None
23 |     if form.validate_on_submit():
24 |         text = form.pagedown.data
25 |         text2 = form.pagedown2.data
26 |     else:
27 |         form.pagedown.data = ('# This is demo #1 of Flask-PageDown\n'
28 |                               '**Markdown** is rendered on the fly in the '
29 |                               '<i>preview area below</i>!')
30 |         form.pagedown2.data = ('# This is demo #2 of Flask-PageDown\nThe '
31 |                                '*preview* is rendered separately from the '
32 |                                '*input*, and in this case it is located above.')
33 |     return render_template('index.html', form=form, text=text, text2=text2)
34 | 
35 | 
36 | if __name__ == '__main__':
37 |     app.run(debug=True)
38 | 


--------------------------------------------------------------------------------
/example/requirements.txt:
--------------------------------------------------------------------------------
 1 | click==8.0.1
 2 | Flask==2.2.3
 3 | Flask-PageDown
 4 | Flask-WTF==1.1.1
 5 | itsdangerous==2.0.1
 6 | Jinja2==3.0.1
 7 | MarkupSafe==2.1.2
 8 | Werkzeug==2.2.3
 9 | WTForms==3.0.1
10 | 


--------------------------------------------------------------------------------
/example/templates/index.html:
--------------------------------------------------------------------------------
 1 | <html>
 2 | <head>
 3 | {{ pagedown.include_pagedown() }}
 4 | <style>
 5 | .flask-pagedown-input {
 6 | }
 7 | .flask-pagedown-preview {
 8 |     border: 1px dotted black;
 9 |     background-color: #f0f0f0;
10 | }
11 | </style>
12 | </head>
13 | <body>
14 |     <h1>Flask-PageDown Demo</h1>
15 |     {% if text or text2 %}
16 |     <div>
17 |         <p>Received text was:</p>
18 |         <pre>{{ text }}</pre>
19 |         <pre>{{ text2 }}</pre>
20 |     </div>
21 |     <hr>
22 |     {% endif %}
23 |     <div style="width: 500px;">
24 |         <form method="POST">
25 |             {{ form.hidden_tag() }}
26 |             <div>
27 |                 <b>{{ form.pagedown.label }}</b>:
28 |                 {{ form.pagedown(rows=10, style='width:100%') }}
29 |             </div>
30 |             <br>
31 |             <div>
32 |                 {{ form.pagedown2(only_preview=True) }}
33 |                 <br>
34 |                 <b>{{ form.pagedown2.label }}</b>:
35 |                 {{ form.pagedown2(only_input=True, rows=10, style='width:100%') }}
36 |             </div>
37 |             <div>{{ form.submit() }}</div>
38 |         </form>
39 |     </div>
40 | </body>
41 | </html>
42 | 


--------------------------------------------------------------------------------
/pyproject.toml:
--------------------------------------------------------------------------------
 1 | [project]
 2 | name = "Flask-PageDown"
 3 | version = "0.4.1.dev0"
 4 | authors = [
 5 |     { name = "Miguel Grinberg", email = "miguel.grinberg@gmail.com" },
 6 | ]
 7 | description = "Implementation of StackOverflow's \"PageDown\" markdown editor for Flask-WTF."
 8 | classifiers = [
 9 |     "Intended Audience :: Developers",
10 |     "Programming Language :: Python :: 3",
11 |     "License :: OSI Approved :: MIT License",
12 |     "Operating System :: OS Independent",
13 | ]
14 | dependencies = [
15 |     "Flask",
16 |     "WTForms",
17 | ]
18 | 
19 | [project.readme]
20 | file = "README.md"
21 | content-type = "text/markdown"
22 | 
23 | [project.urls]
24 | Homepage = "https://github.com/miguelgrinberg/flask-pagedown"
25 | "Bug Tracker" = "https://github.com/miguelgrinberg/flask-pagedown/issues"
26 | 
27 | [tool.setuptools]
28 | zip-safe = false
29 | include-package-data = true
30 | 
31 | [tool.setuptools.package-dir]
32 | "" = "src"
33 | 
34 | [tool.setuptools.packages.find]
35 | where = [
36 |     "src",
37 | ]
38 | namespaces = false
39 | 
40 | [build-system]
41 | requires = [
42 |     "setuptools>=61.2",
43 | ]
44 | build-backend = "setuptools.build_meta"
45 | 
46 | 


--------------------------------------------------------------------------------
/src/flask_pagedown/__init__.py:
--------------------------------------------------------------------------------
 1 | from markupsafe import Markup
 2 | from flask import current_app
 3 | 
 4 | 
 5 | class _pagedown(object):
 6 |     def include_pagedown(self):
 7 |         return Markup('''
 8 | <script type="text/javascript" src="//cdnjs.cloudflare.com/ajax/libs/pagedown/1.0/Markdown.Converter.min.js"></script>
 9 | <script type="text/javascript" src="//cdnjs.cloudflare.com/ajax/libs/pagedown/1.0/Markdown.Sanitizer.min.js"></script>
10 | ''')  # noqa: E501
11 | 
12 |     def html_head(self):
13 |         return self.include_pagedown()
14 | 
15 | 
16 | class PageDown(object):
17 |     def __init__(self, app=None):
18 |         if app is not None:
19 |             self.init_app(app)
20 | 
21 |     def init_app(self, app):
22 |         if not hasattr(app, 'extensions'):
23 |             app.extensions = {}
24 |         app.extensions['pagedown'] = _pagedown()
25 |         app.context_processor(self.context_processor)
26 | 
27 |     @staticmethod
28 |     def context_processor():
29 |         return {'pagedown': current_app.extensions['pagedown']}
30 | 


--------------------------------------------------------------------------------
/src/flask_pagedown/fields.py:
--------------------------------------------------------------------------------
1 | from wtforms.fields import TextAreaField
2 | from .widgets import PageDown
3 | 
4 | 
5 | class PageDownField(TextAreaField):
6 |     widget = PageDown()
7 | 


--------------------------------------------------------------------------------
/src/flask_pagedown/widgets.py:
--------------------------------------------------------------------------------
 1 | from wtforms.widgets import TextArea
 2 | from markupsafe import Markup
 3 | 
 4 | pagedown_pre_html = '<div class="flask-pagedown">'
 5 | pagedown_post_html = '</div>'
 6 | preview_html = '''
 7 | <div class="flask-pagedown-preview" id="flask-pagedown-%(field)s-preview"></div>
 8 | <script type="text/javascript">
 9 | f = function() {
10 |     if (typeof flask_pagedown_converter === "undefined")
11 |         flask_pagedown_converter = Markdown.getSanitizingConverter().makeHtml;
12 |     var textarea = document.getElementById("flask-pagedown-%(field)s");
13 |     var preview = document.getElementById("flask-pagedown-%(field)s-preview");
14 |     textarea.onkeyup = function() { preview.innerHTML = flask_pagedown_converter(textarea.value); }
15 |     textarea.onkeyup.call(textarea);
16 | }
17 | if (document.readyState === 'complete')
18 |     f();
19 | else if (window.addEventListener)
20 |     window.addEventListener("load", f, false);
21 | else if (window.attachEvent)
22 |     window.attachEvent("onload", f);
23 | else
24 |     f();
25 | </script>
26 | '''  # noqa: E501
27 | 
28 | 
29 | class PageDown(TextArea):
30 |     def __call__(self, field, **kwargs):
31 |         show_input = True
32 |         show_preview = True
33 |         if 'only_input' in kwargs or 'only_preview' in kwargs:
34 |             show_input = kwargs.pop('only_input', False)
35 |             show_preview = kwargs.pop('only_preview', False)
36 |         if not show_input and not show_preview:
37 |             raise ValueError('One of show_input and show_preview must be true')
38 |         html = Markup('')
39 |         if show_input:
40 |             class_ = kwargs.pop('class', '').split() + \
41 |                 kwargs.pop('class_', '').split()
42 |             class_ += ['flask-pagedown-input']
43 |             html += Markup(pagedown_pre_html) + super(PageDown, self).__call__(
44 |                 field, id='flask-pagedown-' + field.name,
45 |                 class_=' '.join(class_), **kwargs) + Markup(pagedown_post_html)
46 |         if show_preview:
47 |             html += Markup(preview_html % {'field': field.name})
48 |         return Markup(html)
49 | 


--------------------------------------------------------------------------------
/tox.ini:
--------------------------------------------------------------------------------
 1 | [tox]
 2 | envlist=flake8,py36,py37,py38,py39,pypy3,docs
 3 | skip_missing_interpreters=True
 4 | 
 5 | [gh-actions]
 6 | python =
 7 |     3.6: py36
 8 |     3.7: py37
 9 |     3.8: py38
10 |     3.9: py39
11 |     pypy3: pypy3
12 | 
13 | [testenv]
14 | commands=
15 |     pip install -e .
16 |     pytest -p no:logging --cov=flask_pagedown --cov-branch --cov-report=term-missing --cov-report=xml
17 | deps=
18 |     pytest
19 |     pytest-cov
20 | 
21 | [testenv:pypy3]
22 | deps=
23 |     pytest
24 |     pytest-cov
25 | commands=
26 |     pytest -p no:logging
27 | 
28 | [testenv:flake8]
29 | deps=
30 |     flake8
31 | commands=
32 |     flake8 --exclude=".*" src/flask_pagedown
33 | 
34 | [testenv:docs]
35 | changedir=docs
36 | deps=
37 |     sphinx
38 | whitelist_externals=
39 |     make
40 | commands=
41 |     make html
42 | 


--------------------------------------------------------------------------------