Django markdown support and wysiwyg.
Project description
Home-page: https://github.com/sv0/django-markdown-app
Author: Slavik Svyrydiuk
Author-email: svyrydiuk@gmail.com
License: GNU LGPL
Download-URL: https://github.com/sv0/django-markdown-app/archive/0.9.4.tar.gz
Description-Content-Type: UNKNOWN
Description: Django-Markdown v. 0.9.4
########################
.. _description:
**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.
.. _badges:
.. image:: https://travis-ci.org/sv0/django-markdown-app.svg?branch=master
:target: https://travis-ci.org/sv0/django-markdown-app
:alt: Build Status
.. image:: https://coveralls.io/repos/github/sv0/django-markdown-app/badge.svg?branch=master
:target: https://coveralls.io/github/sv0/django-markdown-app?branch=master
:alt: Coverals
.. image:: http://img.shields.io/pypi/v/django-markdown-app.svg?style=flat-square
:target: https://pypi.python.org/pypi/django-markdown-app
:alt: Version
.. image:: https://img.shields.io/badge/license-LGPL-blue.svg
:target: http://www.gnu.org/copyleft/lesser.html
:alt: License
.. contents::
.. _requirements:
Requirements
============
- python >= 2.7
- django >= 1.8
- markdown >= 2.6.7
.. _installation:
Installation
============
**Django markdown** should be installed using pip: ::
pip install django-markdown-app
Prerequisites
=============
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.
Setup
=====
.. 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')),
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 += [ 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.
Officially supported extensions could be found
at https://python-markdown.github.io/extensions/#officially-supported-extensions
Example: `settings.py` ::
MARKDOWN_EXTENSIONS = ['extra']
**MARKDOWN_EXTENSION_CONFIGS** - configure extensions
**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 changes_ document if you are upgrading from previous version.
Bug tracker
===========
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
Contributing
============
Development of django-markdown happens at github: https://github.com/sv0/django-markdown-app
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
.. _readthedocs: http://django-markdown-app.readthedocs.io
.. _Markitup: http://markitup.jaysalvat.com/
.. _github: https://github.com/sv0/django-markdown-app
.. _klen: https://github.com/klen
.. _yavorskiy: https://github.com/yavorskiy
.. _markdown: https://python-markdown.github.io
.. _changes: changes.html
Keywords: html markdown django
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Framework :: Django :: 2.0
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: GNU Library or Lesser General Public License (LGPL)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Software Development :: Code Generators
Classifier: Topic :: Text Processing :: Markup
Author: Slavik Svyrydiuk
Author-email: svyrydiuk@gmail.com
License: GNU LGPL
Download-URL: https://github.com/sv0/django-markdown-app/archive/0.9.4.tar.gz
Description-Content-Type: UNKNOWN
Description: Django-Markdown v. 0.9.4
########################
.. _description:
**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.
.. _badges:
.. image:: https://travis-ci.org/sv0/django-markdown-app.svg?branch=master
:target: https://travis-ci.org/sv0/django-markdown-app
:alt: Build Status
.. image:: https://coveralls.io/repos/github/sv0/django-markdown-app/badge.svg?branch=master
:target: https://coveralls.io/github/sv0/django-markdown-app?branch=master
:alt: Coverals
.. image:: http://img.shields.io/pypi/v/django-markdown-app.svg?style=flat-square
:target: https://pypi.python.org/pypi/django-markdown-app
:alt: Version
.. image:: https://img.shields.io/badge/license-LGPL-blue.svg
:target: http://www.gnu.org/copyleft/lesser.html
:alt: License
.. contents::
.. _requirements:
Requirements
============
- python >= 2.7
- django >= 1.8
- markdown >= 2.6.7
.. _installation:
Installation
============
**Django markdown** should be installed using pip: ::
pip install django-markdown-app
Prerequisites
=============
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.
Setup
=====
.. 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')),
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 += [ 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.
Officially supported extensions could be found
at https://python-markdown.github.io/extensions/#officially-supported-extensions
Example: `settings.py` ::
MARKDOWN_EXTENSIONS = ['extra']
**MARKDOWN_EXTENSION_CONFIGS** - configure extensions
**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 changes_ document if you are upgrading from previous version.
Bug tracker
===========
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
Contributing
============
Development of django-markdown happens at github: https://github.com/sv0/django-markdown-app
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
.. _readthedocs: http://django-markdown-app.readthedocs.io
.. _Markitup: http://markitup.jaysalvat.com/
.. _github: https://github.com/sv0/django-markdown-app
.. _klen: https://github.com/klen
.. _yavorskiy: https://github.com/yavorskiy
.. _markdown: https://python-markdown.github.io
.. _changes: changes.html
Keywords: html markdown django
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Framework :: Django :: 2.0
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: GNU Library or Lesser General Public License (LGPL)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Software Development :: Code Generators
Classifier: Topic :: Text Processing :: Markup
Project details
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 Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
Close
Hashes for django_markdown_app-0.9.4-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7f3634d95b2199ed8ecfb581db78f95b50aa49ef8206b19d7fb8d2e1aa04f958 |
|
MD5 | 84f85480ec492573919a6c5ddb6806e0 |
|
BLAKE2b-256 | 7859b5b32a3b2b16ae32366c4ea52897be6c9a8892926010923e526c84fc41a5 |