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
django-markdownx is a Markdown editor built for Django
405 commits 6 branches 30 tags 13 MiB
Python 39.4%
TypeScript 27.5%
JavaScript 25.5%
CSS 6.3%
HTML 1.3%
Find a file
adi adcaa9e375
Create SECURITY.md
2022-02-22 10:48:18 +01:00
.github updates name and docs workflow 2022-01-03 15:14:34 +00:00
docs-src adds CI badges 2022-01-03 14:19:04 +00:00
markdownx changes version to beta 1 2022-01-03 15:28:13 +00:00
static-src/markdownx fix getCookie function 2020-01-26 17:06:29 +07:00
testapp integrates new Django URL system w/ backward compatibility 2021-12-27 11:31:55 +00:00
.gitignore Add files related with Docker into .gitignore (#132) 2018-10-16 20:14:56 +02:00
.nojekyll Add GH Actions (#218) 2022-01-03 14:25:46 +00:00
.travis.yml integrates Python 3.10 and Django 3.2 / 4 2021-12-27 11:37:29 +00:00
dev.py Fix the compiling docs from sphinx to mkdocs 2019-02-16 14:42:35 +09:00
dev.xml Fix the compiling docs from sphinx to mkdocs 2019-02-16 14:42:35 +09:00
django-markdownx-preview.gif Works for 1.0 version 2015-09-06 20:46:46 +02:00
LICENSE Licence fix 2016-05-14 21:31:11 +02:00
MANIFEST.in Exclude in dist 2020-02-25 20:20:34 +01:00
mkdocs.yml Documentation rewritten in Markdown! 2018-11-16 23:02:06 +01:00
README.rst adds CI badges 2022-01-03 14:19:04 +00:00
requirements.txt Travis update, cleanup code 2019-12-26 14:23:16 +01:00
SECURITY.md Create SECURITY.md 2022-02-22 10:48:18 +01:00
setup.cfg Universal wheel 2016-06-18 11:10:12 +02:00
setup.py adds Django 4 / Python 3.9 & 3.10 to classifiers 2021-12-27 11:39:21 +00:00
version Add GH Actions (#218) 2022-01-03 14:25:46 +00:00

README.rst

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

================
Django MarkdownX
================

|PyPi_Version| |PyPi_Status| |pypi_format| |Build_Status| |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/uk-covid19
.. |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-2.0,%202.1,%202.2,%203.0,%203.1,%203.2,%204.0-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