Django markdown is django application that allows use markdown wysiwyg in flatpages, admin forms and other forms. Documentaton available at readthedocs or github.
It's a fork of https://github.com/klen/django_markdown
The reason of forking is the original project is not maintained anymore and the owner(klen) is not interested in the merging of the pull requests.
Contents
- python >= 2.7
- django >= 1.8
- markdown >= 2.6.7
Django markdown should be installed using pip:
pip install django-markdown-app
Starting with version 0.9.0, django-markdown-app requires Django 1.8 or later. If you need to support Django versions prior to 1.8 please use django-markdown-app 0.8.5.
Note
'django_markdown' require 'django.contrib.staticfiles' in INSTALLED_APPS
Add 'django_markdown' to INSTALLED_APPS
INSTALLED_APPS += ( 'django_markdown', )
Add django_markdown urls to base urls
url('^markdown/', include( 'django_markdown.urls')),
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 += [ url(r'^admin/', include(admin.site.urls)), ]
Template tags:
<textarea name="test" id="new"></textarea> {% markdown_editor "#new" %} {% markdown_media %}
MARKDOWN_EDITOR_SETTINGS - holds the extra parameters set to be passed to textarea.markItUp()
MARKDOWN_EDITOR_SKIN - skin option, default value is markitup
Example: settings.py
MARKDOWN_EDITOR_SKIN = 'simple'
MARKDOWN_EXTENSIONS - optional list of extensions passed to Markdown, discussed at https://pythonhosted.org/Markdown/extensions/index.html#officially-supported-extensions
Example: settings.py
MARKDOWN_EXTENSIONS = ['extra']
MARKDOWN_EXTENSION_CONFIGS - Configure extensions, discussed at https://pythonhosted.org/Markdown/reference.html#extension_configs
MARKDOWN_PREVIEW_TEMPLATE - Template for preview a markdown. By default django_markdown/preview.css
MARKDOWN_STYLE - path to preview styles. By default django_markdown/preview.css
MARKDOWN_SET_PATH - path to folder with sets. By default django_markdown/sets
MARKDOWN_SET_NAME - name for current set. By default markdown.
MARKDOWN_PROTECT_PREVIEW - protect preview url for staff only
Execute make run in sources directory. Open http://127.0.0.1:8000 in your browser. For admin access use 'root:root' credentials.
Make sure you've read the changes document if you are upgrading from previous version.
If you have any suggestions, bug reports or annoyances please report them to the issue tracker at https://github.com/sv0/django-markdown-app/issues
Development of django-markdown happens at github: https://github.com/sv0/django-markdown-app
Licensed under a GNU lesser general public license.
Copyright (c) 2011 Kirill Klenov (horneds@gmail.com)
- Markitup:
- (c) 2008 Jay Salvat http://markitup.jaysalvat.com/