[Closes #14] README update

This commit is contained in:
adi 2016-02-12 13:47:16 +01:00
parent e20b2acdc6
commit 8ed93f974d
2 changed files with 14 additions and 1 deletions

View file

@ -183,6 +183,19 @@ MARKDOWNX_EDITOR_RESIZABLE = True # update editor's height to inner content heig
* **crop** default: `False` if `True` use `size` to crop final image
* **upscale** default: `False` if image dimensions are smaller than those in `size`, upscale image to `size` dimensions
## Custom MARKDOWNX_MARKDOWN_EXTENSIONS
i.e.:
MARKDOWNX_MARKDOWN_EXTENSIONS = [
'markdown.extensions.extra',
'markdown.extensions.nl2br',
'markdown.extensions.smarty',
]
[Learn more about markdown extensions]
(https://pythonhosted.org/Markdown/extensions/index.html).
## Custom MARKDOWNX_URLS_PATH
Change this path to your app path in `urls.py`. Default view that compiles markdown text:

View file

@ -4,7 +4,6 @@ import os
if 'vagrant' in str(os.environ):
del os.link
def get_requirements():
return open('requirements.txt').read().splitlines()
@ -15,6 +14,7 @@ setup(
packages=find_packages(),
include_package_data=True,
description='Django Markdown editor with image uploads (stored in MEDIA_ROOT folder) and live preview.',
long_description='See full readme: https://github.com/adi-/django-markdownx',
url='https://github.com/adi-/django-markdownx',
author='adi-',
author_email='aaadeji@gmail.com',