django2-markdown 0.8.6

主页：https://github.com/tomasgarzon/django_markdown
作者：Tomas Garzon
作者邮箱：tomasgarzonhervas@gmail.com
许可证：GNU LGPL
描述：Django-Markdown v. 0.8.4
########################

.. _description

**Django markdown**是一个django应用程序，允许在flatpages、admin forms和其他表单中使用markdown wysiwyg。
文档可在pypi_或github_上找到。

.. _badges

.. image:: http://img.shields.io/travis/klen/django_markdown.svg?style=flat-square
:target: http://travis-ci.org/klen/django_markdown
:alt: 构建状态

.. 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
:alt: 版本

.. image:: http://img.shields.io/pypi/dm/django_markdown.svg?style=flat-square
:target: https://pypi.python.org/pypi/django_markdown
:alt: 下载

.. image:: http://img.shields.io/pypi/l/django_markdown.svg?style=flat-square
:target: https://pypi.python.org/pypi/django_markdown
:alt: 许可证

.. image:: http://img.shields.io/gratipay/klen.svg?style=flat-square
:target: https://www.gratipay.com/klen/
:alt: 捐赠

.. contents:

.. _requirements

需求
============

- python >= 2.7
- django >= 1.6
- markdown


.. _installation

安装
============

**Django markdown**应使用pip进行安装：

pip install django-markdown


设置
=====

.. note:: 'django_markdown'需要在INSTALLED_APPS中包含'django.contrib.staticfiles'

- 将'django_markdown'添加到INSTALLED_APPS：

INSTALLED_APPS += ( 'django_markdown', )


- 将django_markdown urls添加到基本urls：

url('^markdown/', include( 'django_markdown.urls')),


使用django_markdown
===================

#) 模型：

from django_markdown.models import MarkdownField
class MyModel(models.Model)
content = MarkdownField()

#) 自定义表单：

from django_markdown.fields import MarkdownFormField
from django_markdown.widgets import MarkdownWidget
class MyCustomForm(forms.Form)
content = forms.CharField(widget=MarkdownWidget())
content2 = MarkdownFormField()

#) 自定义管理器：

从 django_markdown.admin 导入 MarkdownModelAdmin
admin.site.register(MyModel, MarkdownModelAdmin)

）管理覆盖：如果您不想子类化包 ModelAdmin 的：

从 django.contrib 导入 admin

class YourModelAdmin(admin.ModelAdmin)
formfield_overrides = {MarkdownField: {'widget': AdminMarkdownWidget}}

）Flatpages：

在项目主urls中：
从 django_markdown 导入 flatpages
...
）Django admin：
admin.autodiscover()
flatpages.register()
urlpatterns += [ url(r'^admin/', include(admin.site.urls)), ]

）模板标签：

<textarea name="test" id="new"></textarea>
{% markdown_editor "#new" %}
{% markdown_media %}


设置
========

**MARKDOWN_EDITOR_SETTINGS** - 存储要传递给 ``textarea.markItUp()`` 的额外参数

**MARKDOWN_EDITOR_SKIN** - 皮肤选项，默认值为 ``markitup``

示例：`settings.py`：

MARKDOWN_EDITOR_SKIN = 'simple'

**MARKDOWN_EXTENSIONS** - 传递给 Markdown 的可选扩展列表，讨论见 https://pythonhosted.org/Markdown/extensions/index.html#officially-supported-extensions

示例：`settings.py`：

MARKDOWN_EXTENSIONS = ['extra']

**MARKDOWN_EXTENSION_CONFIGS** - 配置扩展，讨论见 https://pythonhosted.org/Markdown/reference.html#extension_configs

**MARKDOWN_PREVIEW_TEMPLATE** - 预览 markdown 的模板。默认为 `django_markdown/preview.css`

**MARKDOWN_STYLE** - 预览样式的路径。默认为 `django_markdown/preview.css`

**MARKDOWN_SET_PATH** - 包含集的文件夹的路径。默认为 `django_markdown/sets`

**MARKDOWN_SET_NAME** - 当前集的名称。默认为 `markdown`。

**MARKDOWN_PROTECT_PREVIEW** - 仅对工作人员保护预览 URL


示例
========

在源目录中执行 `make run`。在您的浏览器中打开 http://127.0.0.1:8000。
对于管理员访问，使用 'root:root' 凭据。


变更
=======

如果您是从旧版本升级，请确保您已阅读以下文档

http://packages.python.org/django-markdown/changes.html


错误追踪器
===========

如果您有任何建议、错误报告或
烦恼，请向问题跟踪器报告
在 https://github.com/klen/django_markdown/issues


贡献
============

django-markdown 的开发发生在 github：https://github.com/klen/django_markdown


贡献者
=============

* klen_ (Kirill Klenov)

* yavorskiy_ (Sergii Iavorskyi)


许可证
=======

许可协议为 `GNU lesser general public license`_。


版权
=========

版权（c）2011 Kirill Klenov (horneds@gmail.com)

Markitup_
(c) 2008 Jay Salvat
http://markitup.jaysalvat.com/


.. _GNU lesser general public license: https://gnu.ac.cn/copyleft/lesser.html
.. _pypi: http://packages.python.org/django-markdown/
.. _Markitup: http://markitup.jaysalvat.com/
.. _github: https://github.com/klen/django_markdown
.. _klen: https://github.com/klen
.. _yavorskiy: https://github.com/yavorskiy

关键词：html markdown django
平台：UNKNOWN
分类器：开发状态 :: 5 - 生产/稳定
分类器：目标受众 :: 开发者
分类器：自然语言 :: 英语
分类器：许可证 :: OSI 批准 :: GNU 库或较小通用公共许可证 (LGPL)
分类器：编程语言 :: Python
分类器：主题 :: 软件开发 :: 代码生成器
分类器：主题 :: 文本处理 :: 标记