mirror of
https://github.com/Hopiu/django-markdownx.git
synced 2026-04-12 17:21:01 +00:00
README unification
This commit is contained in:
adi
parent
9516dcf0ed
commit
05f324dd44
3 changed files with 18 additions and 53 deletions
17
README.rst
17
README.rst
|
|
@ -2,16 +2,19 @@
|
|||
Django MarkdownX
|
||||
================
|
||||
|
||||
|PyPi_Status| |Build_Status| |Format| |Supported_versions_of_Python| |Supported_versions_of_Django| |License| |GitHub Star| |GitHub Watch|
|
||||
|PyPi_Version| |PyPi_Status| |Build_Status| |Format| |Supported_versions_of_Python| |Supported_versions_of_Django| |License| |GitHub Star| |GitHub Watch|
|
||||
|
||||
------------
|
||||
|
||||
Documentation: http://neutronx.github.io/django-markdownx/
|
||||
Source: https://github.com/neutronX/django-markdownx/
|
||||
Django MarkdownX is a comprehensive Markdown_ plugin built for Django_, the renowned high-level Python web framework, with flexibility, extensibility, and ease-of-use at its core.
|
||||
|
||||
Documentation
|
||||
=============
|
||||
http://neutronx.github.io/django-markdownx/
|
||||
|
||||
|
||||
Key features
|
||||
````````````
|
||||
============
|
||||
|
||||
* Raw editing.
|
||||
* Live preview.
|
||||
|
|
@ -25,14 +28,20 @@ Key features
|
|||
* Multiple editors per page.
|
||||
* Django Admin support.
|
||||
|
||||
Preview
|
||||
=======
|
||||
|
||||
.. image:: https://github.com/neutronX/django-markdownx/raw/master/django-markdownx-preview.gif?raw=true
|
||||
:target: https://github.com/neutronX/django-markdownx
|
||||
:align: center
|
||||
:alt: django-markdownx preview
|
||||
|
||||
*(using Bootstrap for layout and styling)*
|
||||
|
||||
.. _Markdown: https://en.wikipedia.org/wiki/Markdown
|
||||
.. _Django: https://www.djangoproject.com
|
||||
|
||||
.. |PyPi_Version| image:: https://img.shields.io/pypi/v/django-markdownx.svg
|
||||
.. |PyPi_Status| image:: https://img.shields.io/pypi/status/django-markdownx.svg
|
||||
.. |Build_Status| image:: https://img.shields.io/travis/neutronX/django-markdownx.svg
|
||||
.. |Format| image:: https://img.shields.io/pypi/format/django-markdownx.svg
|
||||
|
|
|
|||
|
|
@ -13,53 +13,6 @@ __maintainer__ = 'Adi, Pouria Hadjibagheri'
|
|||
__url__ = 'https://github.com/neutronX/django-markdownx'
|
||||
__version__ = '2.0.1'
|
||||
__description__ = 'A comprehensive Markdown editor built for Django.'
|
||||
__long_description__ = '''================
|
||||
Django MarkdownX
|
||||
================
|
||||
|
||||
|PyPi_Status| |Build_Status| |Format| |Supported_versions_of_Python| |Supported_versions_of_Django| |License| |GitHub Star| |GitHub Watch|
|
||||
|
||||
------------
|
||||
|
||||
Documentations
|
||||
--------------
|
||||
|
||||
Django MarkdownX is a comprehensive Markdown_ plugin built for Django_, the renowned high-level
|
||||
Python web framework, with flexibility, extensibility, and ease-of-use at its core.
|
||||
|
||||
|
||||
Key features
|
||||
````````````
|
||||
|
||||
* Raw editing.
|
||||
* Live preview.
|
||||
* Drag & drop image uploads (automatically stored in the designated location in the *Media* directory).
|
||||
* Customizable image insertion tag.
|
||||
* Definition of maximum size for an image.
|
||||
* Definition of acceptable image formats (PNG, JPEG, SVG).
|
||||
* Image manipulations (compression, size reduction, cropping, upscaling).
|
||||
* Pre- and post- text modification.
|
||||
* Easy template customization, layout modification, and personalization.
|
||||
* Multiple editors per page.
|
||||
* Django Admin support.
|
||||
|
||||
.. image:: https://github.com/neutronX/django-markdownx/raw/master/django-markdownx-preview.gif?raw=true
|
||||
:target: https://github.com/neutronX/django-markdownx
|
||||
:align: center
|
||||
:alt: django-markdownx preview
|
||||
|
||||
.. _Markdown: https://en.wikipedia.org/wiki/Markdown
|
||||
.. _Django: https://www.djangoproject.com
|
||||
|
||||
.. |PyPi_Status| image:: https://img.shields.io/pypi/status/django-markdownx.svg
|
||||
.. |Build_Status| image:: https://img.shields.io/travis/neutronX/django-markdownx.svg
|
||||
.. |Format| image:: https://img.shields.io/pypi/format/django-markdownx.svg
|
||||
.. |Supported_versions_of_Python| image:: https://img.shields.io/pypi/pyversions/django-markdownx.svg
|
||||
.. |Supported_versions_of_Django| image:: https://img.shields.io/badge/Django-1.8,%201.9,%201.10-green.svg
|
||||
.. |License| image:: https://img.shields.io/pypi/l/django-markdownx.svg
|
||||
.. |GitHub Star| image:: https://img.shields.io/github/stars/neutronx/django-markdownx.svg?style=social&label=Star
|
||||
.. |GitHub Watch| image:: https://img.shields.io/github/watchers/neutronx/django-markdownx.svg?style=social&label=Watch
|
||||
'''
|
||||
# ~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-
|
||||
|
||||
|
||||
|
|
|
|||
7
setup.py
7
setup.py
|
|
@ -51,7 +51,6 @@ def get_meta():
|
|||
|
||||
keys = {
|
||||
'__description__',
|
||||
'__long_description__',
|
||||
'__credits__',
|
||||
'__copyright__',
|
||||
'__license__',
|
||||
|
|
@ -84,6 +83,10 @@ def get_requirements():
|
|||
req = requirements.read().splitlines()
|
||||
return req
|
||||
|
||||
def readme():
|
||||
with open('README.rst') as f:
|
||||
return f.read()
|
||||
|
||||
|
||||
metadata = get_meta()
|
||||
|
||||
|
|
@ -94,7 +97,7 @@ setup(
|
|||
maintainer=metadata.get('maintainer'),
|
||||
include_package_data=True,
|
||||
description=metadata.get('description'),
|
||||
long_description=metadata.get('long_description'),
|
||||
long_description=readme(),
|
||||
url=metadata.get('url'),
|
||||
license=metadata.get('license'),
|
||||
classifiers=[
|
||||
|
|
|
|||
Loading…
Reference in a new issue