From 49cff229d95de9f2cd0d2c2b0b320179d48b1c23 Mon Sep 17 00:00:00 2001 From: Timmy O'Mahony Date: Fri, 13 Sep 2019 18:07:16 +0100 Subject: [PATCH] Updated requirements in readme and remove markdown warning --- README.md | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 70cf85f..ca713eb 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ Add [Stack Overflow's "Pagedown" Markdown editor](https://github.c ## Requirements -The widget has been vastly simplified so that it's easier to drop-into your projects and easier to customise. Version >= 2.0.0 requires Django 2.1.0 or above. +Version >= 2.0.0 of `django-pagedown` requires Django 2.1.0 or above (previous versions should support Django all the way back to around 1.1). ## Installation @@ -15,10 +15,6 @@ The widget has been vastly simplified so that it's easier to drop-into your proj 2. Add `pagedown.apps.PagedownConfig` to your `INSTALLED_APPS` 3. Collect the static files: `python manage.py collectstatic` -## Markdown Safety - -Remember that this library doesn't render your markdown for you outside of the admin widget nor does it do any internal sanitization. Markdown can accept any valid HTML so you have to be careful and make sure you are rendering the output of any untrusted input safely (with [`django-markdown-deux`](https://github.com/trentm/django-markdown-deux) for example), otherwise you could have users embedding scripts in your pagedown text areas - ## Usage The widget can be used both inside the django admin or independendly. @@ -140,7 +136,7 @@ class MyNewWidget(PagedownWidget): js = ('custom/javascript.js',) ``` -## Rendering Markdown In Your Template +## Rendering Markdown `contrib.markdown` was [depreciated in Django 1.5](https://code.djangoproject.com/ticket/18054) meaning you can no longer use the `markdown` filter in your template by default.