Hopiu/django-markdownx
1
0
Fork 0
mirror of https://github.com/Hopiu/django-markdownx.git synced 2026-03-16 21:40:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

README updates

Browse source
This commit is contained in:
adi 2016-08-18 22:03:44 +02:00
parent be27e81f01
commit f671969eb9
2 changed files with 35 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
README.md
View file

@ -7,30 +7,25 @@
[![Django Versions](https://img.shields.io/badge/Django-1.8,%201.9,%201.10-green.svg)](https://www.djangoproject.com/)
[![License](https://img.shields.io/pypi/l/django-markdownx.svg)](https://pypi.python.org/pypi/django-markdownx/)
**django-markdownx** is a Markdown editor built for Django.
#### Key features
**Key features**:
* raw editing,
* live preview,
* drag&drop image uploads (stored locally in `MEDIA` folder),
* customizable image insertion tag,
* image filtering using content types and max file size,
* image manipulations (compression, size, cropping),
* pre- & post- text altering,
* easy template customization for layout purposes,
* raw editing
* live preview
* drag&drop image uploads (stored locally in `MEDIA` folder)
* customizable image insertion tag
* image filtering using content types and max file size
* image manipulations (compression, size, cropping, upscaling)
* pre-&post- text altering
* easy template customization for layout purposes
* multiple editors on one page
* Django Admin support
**Preview**:
#### Preview
![Preview](https://github.com/adi-/django-markdownx/blob/master/django-markdownx-preview.gif?raw=true "Preview")
<sup>*(using Bootstrap for layout and styling)*</sup>
Template is highly customizable, so you can easily use i.e. Bootstrap to layout editor pane and preview pane side by side. Using multiple editors on one page is supported.
*Side note: Just to keep it simple, all UI editing controls are unwelcome – this is Markdown editor not a web MS Word imitation.*
# Menu

27
setup.py
View file

@ -13,10 +13,31 @@ setup(
version='1.6.2',
packages=find_packages(),
include_package_data=True,
description='Django Markdownx is a Markdown editor built for Django. It enables raw editing, live preview and image uploads (stored in `MEDIA` folder) with drag&drop functionality and auto tag insertion.',
long_description='See full readme: https://github.com/adi-/django-markdownx',
description='django-markdownx is a Markdown editor built for Django.',
long_description='''Key features
------------
* raw editing
* live preview
* drag&drop image uploads (stored locally in `MEDIA` folder)
* customizable image insertion tag
* image filtering using content types and max file size
* image manipulations (compression, size, cropping, upscaling)
* pre-&post- text altering
* easy template customization for layout purposes
* multiple editors on one page
* Django Admin support
Preview
-------
.. image:: https://github.com/adi-/django-markdownx/raw/master/django-markdownx-preview.gif?raw=true
:target: https://github.com/adi-/django-markdownx
:alt: django-markdownx preview
*(using Bootstrap for layout and styling)*
''',
url='https://github.com/adi-/django-markdownx',
download_url='https://github.com/adi-/django-markdownx/archive/master.zip',
license='BSD',
classifiers=[
'Development Status :: 5 - Production/Stable',