django-markdown 0.8.4

需求

• python >= 2.7

• django >= 1.6

• markdown

安装

Django markdown 应使用pip安装

pip install django-markdown

设置

• 将‘django_markdown’添加到INSTALLED_APPS

  INSTALLED_APPS += ( 'django_markdown', )

• 将django_markdown urls添加到基本urls

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

使用django_markdown

1. 模型

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

2. 自定义表单

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

3. 自定义管理员

   from django_markdown.admin import MarkdownModelAdmin
   admin.site.register(MyModel, MarkdownModelAdmin)

4. 管理覆盖： (如果您不想从包的ModelAdmin派生)

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

5. 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)), ]

6. 模板标签

   <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](https://github.com/klen/django_markdown/issues)

贡献

django-markdown 的开发在 github 上进行：[https://github.com/klen/django_markdown](https://github.com/klen/django_markdown)

贡献者

• klen (Kirill Klenov)

• yavorskiy (Sergii Iavorskyi)

许可

许可协议：[GNU lesser general public license](https://gnu.ac.cn/copyleft/lesser.html)

版权

版权所有 (c) 2011 Kirill Klenov (horneds@gmail.com)

Markitup:

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