Django markdown support and wysiwyg.
Project description
Django markdown is django application that allows use markdown wysiwyg in flatpages, admin forms and other forms. Documentaton available at pypi or github.
Requirements
python >= 2.7
django >= 1.5
markdown
Installation
Django markdown should be installed using pip:
pip install django-markdown
Setup
Add ‘django_markdown’ to INSTALLED_APPS
INSTALLED_APPS += ( 'django_markdown', )
Add django_markdown urls to base urls
url('^markdown/', include( 'django_markdown.urls')),
Use django_markdown
Custom forms:
from django_markdown.widgets import MarkdownWidget class MyCustomForm(forms.Form): content = forms.CharField(widget=MarkdownWidget())Custom admins:
from django_markdown.admin import MarkdownModelAdmin admin.site.register(MyModel, MarkdownModelAdmin)
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 %}
Settings
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
Examples
Execute make run in sources directory. Open http://127.0.0.1:8000 in your browser. For admin access use ‘root:root’ credentials.
Changes
Make sure you`ve read the following document if you are upgrading from previous versions:
Bug tracker
If you have any suggestions, bug reports or annoyances please report them to the issue tracker at https://github.com/klen/django_markdown/issues
Contributing
Development of django-markdown happens at github: https://github.com/klen/django_markdown
Contributors
License
Licensed under a GNU lesser general public license.
Copyright
Copyright (c) 2011 Kirill Klenov (horneds@gmail.com)
- Markitup:
(c) 2008 Jay Salvat http://markitup.jaysalvat.com/
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file django-markdown-0.7.0.tar.gz.
File metadata
- Download URL: django-markdown-0.7.0.tar.gz
- Upload date:
- Size: 67.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 6a099127c251701cb5492abdef30c6fc33e43901dcfa88274ea81f7f418055c4 |
|
| MD5 | bff98a16b30acf05b36cfbb31a04fc54 |
|
| BLAKE2b-256 | 97ebe240a0bbcfd3fcff7be6da2451fb65446b6e434a7cb845948d64e7a1d529 |
File details
Details for the file django_markdown-0.7.0-py2.py3-none-any.whl.
File metadata
- Download URL: django_markdown-0.7.0-py2.py3-none-any.whl
- Upload date:
- Size: 94.6 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 0c31b453e0e59e2b3806bceac9adbefeb495caf5d26e94d35cbdbfd3b8bd76f7 |
|
| MD5 | d721a8263563d587b738c6911183da14 |
|
| BLAKE2b-256 | fe02537ab03cb8c481dedbf502363f800d84373f96270d61cb307a1b06cc92ef |
