Package: django-markdown-2
Django-Markdown v. 2.0.0
########################.. _description:Django markdownis django application that allows use markdown wysiwyg in flatpages, admin forms and other forms.
Documentaton available at pypi_ or github_... _badges:.. image::http://img.shields.io/travis/klen/django_markdown.svg?style=flat-square:target:https://travis-ci.org/github/been-there-done-that:alt: Build Status.. image::http://img.shields.io/coveralls/klen/django_markdown.svg?style=flat-square:target:https://coveralls.io/r/klen/django_markdown:alt: Coverals.. image::http://img.shields.io/pypi/v/django_markdown.svg?style=flat-square:target:https://pypi.python.org/pypi/django_markdown-2:alt: Version.. image::http://img.shields.io/pypi/dm/django_markdown.svg?style=flat-square:target:https://pypi.python.org/pypi/django_markdown-2:alt: Downloads.. image::http://img.shields.io/pypi/l/django_markdown.svg?style=flat-square:target:https://pypi.python.org/pypi/django_markdown-2:alt: License.. image::http://img.shields.io/gratipay/klen.svg?style=flat-square:target:https://www.gratipay.com/klen/:alt: Donate.. contents::.. _requirements:Requirementspython >= 3.6django >= 1.8markdown.. _installation:InstallationDjango markdownshould be installed using pip: ::pip install django-markdownSetup.. note:: 'django_markdown' require 'django.contrib.staticfiles' in INSTALLED_APPSAdd 'django_markdown' to INSTALLED_APPS ::'django_markdown',Add django_markdown urls to base urls ::re_path('^markdown/', include( 'django_markdown.urls')),Use django_markdown#) Models: ::from django_markdown.models import MarkdownField
class MyModel(models.Model):
    content = MarkdownField()#) Custom forms: ::from django_markdown.fields import MarkdownFormField
from django_markdown.widgets import MarkdownWidget
class MyCustomForm(forms.Form):
    content = forms.CharField(widget=MarkdownWidget())
    content2 = MarkdownFormField()#) Custom admins: ::from django_markdown.admin import MarkdownModelAdmin
admin.site.register(MyModel, MarkdownModelAdmin)#) Admin Overrides: (If you don't want to subclass package ModelAdmin's) ::from django.contrib import admin

class YourModelAdmin(admin.ModelAdmin):
    formfield_overrides = {MarkdownField: {'widget': AdminMarkdownWidget}}#) Flatpages: ::# in your project main urls
from django_markdown import flatpages
...

# Django admin
admin.autodiscover()
flatpages.register()

urlpatterns += [ re_path(r'^admin/', include(admin.site.urls)), ]#) Template tags: ::<textarea name="test" id="new"></textarea>
{% markdown_editor "#new" %}
{% markdown_media %}SettingsMARKDOWN_EDITOR_SETTINGS- holds the extra parameters set to be passed totextarea.markItUp()MARKDOWN_EDITOR_SKIN- skin option, default value ismarkitupExample:settings.py::MARKDOWN_EDITOR_SKIN = 'simple'MARKDOWN_EXTENSIONS- optional list of extensions passed to Markdown, discussed athttps://pythonhosted.org/Markdown/extensions/index.html#officially-supported-extensionsExample:settings.py::MARKDOWN_EXTENSIONS = ['extra']MARKDOWN_EXTENSION_CONFIGS- Configure extensions, discussed athttps://pythonhosted.org/Markdown/reference.html#extension_configsMARKDOWN_PREVIEW_TEMPLATE- Template for preview a markdown. By defaultdjango_markdown/preview.cssMARKDOWN_STYLE- path to preview styles. By defaultdjango_markdown/preview.cssMARKDOWN_SET_PATH- path to folder with sets. By defaultdjango_markdown/setsMARKDOWN_SET_NAME- name for current set. By defaultmarkdown.MARKDOWN_PROTECT_PREVIEW- protect preview url for staff onlyExamplesExecutemake runin sources directory. Openhttp://127.0.0.1:8000in your
browser. For admin access use 'root:root' credentials.ChangesMake sure you`ve read the following document if you are upgrading from previous versions:http://packages.python.org/django-markdown-2/changes.htmlBug trackerIf you have any suggestions, bug reports or
annoyances please report them to the issue tracker
athttps://github.com/been-there-done-that/django_markdown-2/issuesContributingDevelopment of django-markdown happens at github:https://github.com/been-there-done-that/django_markdown-2ContributorsDeesh_ (Jagadeeswara_Reddy_p)LicenseLicensed under aGNU lesser general public license_.CopyrightCopyright (c) 2021 Deesh Reddy (internetwasmyidea@gmail.com)Markitup_:
(c) 2008 Jay Salvathttp://markitup.jaysalvat.com/.. _GNU lesser general public license:http://www.gnu.org/copyleft/lesser.html.. _pypi:http://packages.python.org/django-markdown-2/.. _Markitup:http://markitup.jaysalvat.com/.. _github:https://github.com/been-there-done-that/django_markdown.. _Deesh:https://github.com/been-there-done-that