django-markdownx/docs-src/index.md
Pouria Hadjibagheri de7f21823f
adds CI badges
2022-01-03 14:19:04 +00:00

43 lines
2.2 KiB
Markdown

# Django MarkdownX
![](https://img.shields.io/pypi/v/django-markdownx.svg)
![](https://img.shields.io/pypi/status/django-markdownx)
![](https://img.shields.io/pypi/format/uk-covid19)
![](https://img.shields.io/travis/neutronX/django-markdownx.svg)
![](https://img.shields.io/pypi/pyversions/django-markdownx.svg)
![](https://img.shields.io/badge/Django-2.0,%202.1,%202.2,%203.0,%203.1,%203.2,%204.0-green.svg)
![](https://img.shields.io/pypi/l/django-markdownx.svg)
![Master branch tests](https://github.com/neutronX/django-markdownx/actions/workflows/run-tests.yml/badge.svg?branch=master)
![PyPI CI](https://github.com/neutronX/django-markdownx/actions/workflows/python-publish.yml/badge.svg?event=release)
Django MarkdownX is a comprehensive [Markdown](https://en.wikipedia.org/wiki/Markdown) plugin built for [Django](https://www.djangoproject.com), the renowned high-level Python web framework, with flexibility, extensibility, and ease-of-use at its core.
**GitHub:** [https://github.com/neutronX/django-markdownx](https://github.com/neutronX/django-markdownx)<br>
**PyPi:** [https://pypi.org/project/django-markdownx/](https://pypi.org/project/django-markdownx/)
## 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.
## Preview
![django-markdownx preview](https://github.com/neutronX/django-markdownx/raw/master/django-markdownx-preview.gif?raw=true)
## Acknowledgements
We acknowledge and appreciate every contribution made towards improving **Django MarkdownX**, a list of which can be
found on our [GitHub contributors page](https://github.com/adi-/django-markdownx/graphs/contributors).
**Django MarkdownX** was inspired by the great [Django Images](https://github.com/mirumee/django-images) and
[Django Bootstrap Markdown](https://github.com/aj-may/django-bootstrap-markdown) packages.