Django markdown support and wysiwyg.
Project description
django-markdown
###############
**Django markdown** is django application that allows use markdown wysiwyg in flatpages, admin forms and other forms.
Documentaton available at pypi_ or github_.
.. contents::
Requirements
============
- python >= 2.5
- django >= 1.2
- 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
===================
1) Custom forms: ::
from django_markdown.widgets import MarkdownWidget
class MyCustomForm(forms.Form):
content = forms.CharField( widget=MarkdownWidget() )
2) Custom admins: ::
from django_markdown.admin import MarkdownModelAdmin
adimin.site.register(MyModel, MarkdownModelAdmin)
3) 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)), ]
Settings
========
**MARKDOWN_SKIN** - skin option, default value is ``markitup``
Example: `settings.py` ::
MARKDOWN_SKIN = 'simple'
**MARKDOWN_EDITOR_SETTINGS** - holds the extra parameters set to be passed to textarea.markItUp()
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
=============
* klen_ (Kirill Klenov)
* yavorskiy_ (Sergii Iavorskyi)
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/
.. _GNU lesser general public license: http://www.gnu.org/copyleft/lesser.html
.. _pypi: http://packages.python.org/scss/
.. _github: https://github.com/klen/python-scss
.. _klen: https://github.com/klen
.. _yavorskiy: https://github.com/yavorskiy
###############
**Django markdown** is django application that allows use markdown wysiwyg in flatpages, admin forms and other forms.
Documentaton available at pypi_ or github_.
.. contents::
Requirements
============
- python >= 2.5
- django >= 1.2
- 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
===================
1) Custom forms: ::
from django_markdown.widgets import MarkdownWidget
class MyCustomForm(forms.Form):
content = forms.CharField( widget=MarkdownWidget() )
2) Custom admins: ::
from django_markdown.admin import MarkdownModelAdmin
adimin.site.register(MyModel, MarkdownModelAdmin)
3) 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)), ]
Settings
========
**MARKDOWN_SKIN** - skin option, default value is ``markitup``
Example: `settings.py` ::
MARKDOWN_SKIN = 'simple'
**MARKDOWN_EDITOR_SETTINGS** - holds the extra parameters set to be passed to textarea.markItUp()
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
=============
* klen_ (Kirill Klenov)
* yavorskiy_ (Sergii Iavorskyi)
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/
.. _GNU lesser general public license: http://www.gnu.org/copyleft/lesser.html
.. _pypi: http://packages.python.org/scss/
.. _github: https://github.com/klen/python-scss
.. _klen: https://github.com/klen
.. _yavorskiy: https://github.com/yavorskiy
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
django-markdown-0.0.6.tar.gz
(106.1 kB
view details)
File details
Details for the file django-markdown-0.0.6.tar.gz.
File metadata
- Download URL: django-markdown-0.0.6.tar.gz
- Upload date:
- Size: 106.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 6e79ab7eb465569719779de474a15fc2871110051eb01f4a8b0fe31f19aba311 |
|
| MD5 | 524393800523909e4de0bc020c8ca8b5 |
|
| BLAKE2b-256 | 961e29908127cd0f88563c88ba44f612627a2abb19ccde22df5a4ad85a9a79be |
