https://github.com/adi-/django-markdownx

Comprehensive Markdown plugin built for Django
https://github.com/adi-/django-markdownx

django editor markdown markdownx python

Last synced: about 2 months ago
JSON representation

Comprehensive Markdown plugin built for Django

• Host: GitHub
• URL: https://github.com/adi-/django-markdownx
• Owner: neutronX
• License: other
• Created: 2014-11-01T14:15:37.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2023-12-08T19:17:13.000Z (10 months ago)
• Last Synced: 2024-04-15T08:14:12.179Z (5 months ago)
• Topics: django, editor, markdown, markdownx, python
• Language: Python
• Homepage: https://neutronx.github.io/django-markdownx/
• Size: 15.8 MB
• Stars: 823
• Watchers: 22
• Forks: 151
• Open Issues: 53
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

• -awesome-django - django-markdownx - Comprehensive Markdown plugin built for Django. (Third-Party Packages / Editors)
• awesome-django - django-markdownx - Comprehensive Markdown plugin built for Django. (Third-Party Packages / Editors)

README

        
================

Django MarkdownX

================

|PyPi_Version| |PyPi_Status| |pypi_format| |Supported_versions_of_Python| |Supported_versions_of_Django| |License| |master_branch_tests| |pypi_ci|

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/

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

=======

.. 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 – not included in package)*

.. _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

.. |pypi_format| image:: https://img.shields.io/pypi/format/django-markdownx

.. |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-%203.0,%203.1,%203.2,%204.0,%204.1-green.svg

.. |License| image:: https://img.shields.io/pypi/l/django-markdownx.svg

.. |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