django-markdownx/README.rst

52 lines
2.3 KiB
ReStructuredText
Raw Permalink Normal View History

2017-04-23 19:28:40 +00:00
================
Django MarkdownX
================
2022-01-03 14:19:04 +00:00
|PyPi_Version| |PyPi_Status| |pypi_format| |Build_Status| |Format| |Supported_versions_of_Python| |Supported_versions_of_Django| |License| |master_branch_tests| |pypi_ci|
2017-04-23 19:28:40 +00:00
2017-04-23 19:42:48 +00:00
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
=============
https://neutronx.github.io/django-markdownx/
2017-04-23 19:28:40 +00:00
Key features
2017-04-23 19:42:48 +00:00
============
2017-04-23 19:28:40 +00:00
* 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.
2017-04-23 19:42:48 +00:00
Preview
=======
2017-04-23 19:28:40 +00:00
.. 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
2019-12-26 19:22:57 +00:00
*(using Bootstrap for layout and styling not included in package)*
2017-04-23 19:42:48 +00:00
2017-04-23 19:28:40 +00:00
.. _Markdown: https://en.wikipedia.org/wiki/Markdown
.. _Django: https://www.djangoproject.com
2017-04-23 19:42:48 +00:00
.. |PyPi_Version| image:: https://img.shields.io/pypi/v/django-markdownx.svg
2017-04-23 19:28:40 +00:00
.. |PyPi_Status| image:: https://img.shields.io/pypi/status/django-markdownx.svg
2022-01-03 14:19:04 +00:00
.. |pypi_format| image:: https://img.shields.io/pypi/format/uk-covid19
2017-04-23 19:28:40 +00:00
.. |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
2021-12-27 11:41:16 +00:00
.. |Supported_versions_of_Django| image:: https://img.shields.io/badge/Django-2.0,%202.1,%202.2,%203.0,%203.1,%203.2,%204.0-green.svg
2017-04-23 19:28:40 +00:00
.. |License| image:: https://img.shields.io/pypi/l/django-markdownx.svg
2022-01-03 14:19:04 +00:00
.. |master_branch_tests| image:: https://github.com/neutronX/django-markdownx/actions/workflows/run-tests.yml/badge.svg?branch=master
.. |pypi_ci| image:: https://github.com/neutronX/django-markdownx/actions/workflows/python-publish.yml/badge.svg?event=release