漂亮的Django Markdown富文本app插件的實(shí)現(xiàn)

更新時(shí)間：2019年01月02日 11:00:00 作者：DeanWu

這篇文章主要介紹了漂亮的Django Markdown富文本app插件的實(shí)現(xiàn)，小編覺(jué)得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧

django-mdeditor

Github地址:https://github.com/pylixm/django-mdeditor 歡迎試用，star收藏！

Django-mdeditor 是基于Editor.md 的一個(gè) django Markdown 文本編輯插件應(yīng)用。

Django-mdeditor 的靈感參考自偉大的項(xiàng)目django-ckeditor.

功能

支持 Editor.md 大部分功能
- 支持標(biāo)準(zhǔn)的Markdown 文本、 CommonMark 和 GFM (GitHub Flavored Markdown) 文本;
- 支持實(shí)時(shí)預(yù)覽、圖片上傳、格式化代碼、搜索替換、皮膚、多語(yǔ)言等。
- 支持TOC 目錄和表情；
- 支持 TeX, 流程圖、時(shí)序圖等圖表擴(kuò)展。
可自定義 Editor.md 工具欄。
提供了 MDTextField 字段用來(lái)支持模型字段使用。
提供了 MDTextFormField 字段用來(lái)支持 Form 和 ModelForm.
提供了 MDEditorWidget 字段用來(lái)支持 admin 自定義樣式使用。

快速入門(mén)

安裝

pip install django-mdeditor

在 settings 配置文件 INSTALLED_APPS 中添加 mdeditor:

  INSTALLED_APPS = [
    ...
    'mdeditor',
  ]

在 settings 中添加媒體文件的路徑配置:

MEDIA_ROOT = os.path.join(BASE_DIR, 'uploads')
MEDIA_URL = '/media/'

在你項(xiàng)目根目錄下創(chuàng)建 uploads/editor 目錄，用于存放上傳的圖片。

在你項(xiàng)目的根 urls.py 中添加擴(kuò)展url和媒體文件url:

from django.conf.urls import url, include
from django.conf.urls.static import static
from django.conf import settings
...

urlpatterns = [
  ...
  url(r'mdeditor/', include('mdeditor.urls'))
]

if settings.DEBUG:
  # static files (images, css, javascript, etc.)
  urlpatterns += static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)

編寫(xiě)一個(gè)測(cè)試 model :

from django.db import models
from mdeditor.fields import MDTextField

class ExampleModel(models.Model):
  name = models.CharField(max_length=10)
  content = MDTextField()

向 admin.py 中注冊(cè)model:

from django.contrib import admin
from . import models

admin.site.register(models.ExampleModel)

運(yùn)行 python manage.py makemigrations 和 python manage.py migrate 來(lái)創(chuàng)建你的model 數(shù)據(jù)庫(kù)表.

登錄 django admin后臺(tái)，點(diǎn)擊 '添加'操作，你會(huì)看到如下界面。

到此，你已經(jīng)初步體驗(yàn)了 djang-mdeditor ，接下來(lái)詳細(xì)看下他的其他使用吧。

用法說(shuō)明

在model 中使用 Markdown 編輯字段

在model 中使用 Markdown 編輯字段，我們只需要將 model 的TextField 替換成MDTextField 即可。

from django.db import models
from mdeditor.fields import MDTextField

class ExampleModel(models.Model):
  name = models.CharField(max_length=10)
  content = MDTextField()

在后臺(tái)admin中，會(huì)自動(dòng)顯示 markdown 的編輯富文本。

在前端 template 中使用時(shí)，可以這樣用：

{% load staticfiles %}
<!DOCTYPE html>
<html lang="zh">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

  </head>
  <body>
    <form method="post" action="./">
      {% csrf_token %}
      {{ form.media }}
      {{ form.as_p }}
      <p><input type="submit" value="post"></p>
    </form>
  </body>
</html>

在 Form 中使用 markdown 編輯字段

在 Form 中使用 markdown 編輯字段，使用 MDTextFormField 代替 forms.CharField, 如下：

from mdeditor.fields import MDTextFormField

class MDEditorForm(forms.Form):
  name = forms.CharField()
  content = MDTextFormField()

ModelForm 可自動(dòng)將model 對(duì)應(yīng)的字段轉(zhuǎn)為 form字段，可正常使用：

class MDEditorModleForm(forms.ModelForm):

  class Meta:
    model = ExampleModel
    fields = '__all__'

在 admin 中使用 markdown 小組件

在 admin 中使用 markdown 小組件，如下：

from django.contrib import admin
from django.db import models

# Register your models here.
from . import models as demo_models
from mdeditor.widgets import MDEditorWidget


class ExampleModelAdmin(admin.ModelAdmin):
  formfield_overrides = {
    models.TextField: {'widget': MDEditorWidget}
  }


admin.site.register(demo_models.ExampleModel, ExampleModelAdmin)

自定義工具欄

在 settings 中增加如下配置：

MDEDITOR_CONFIGS = {
  'width': '90%', # 自定義編輯框?qū)挾?
  'heigth': 500,  # 自定義編輯框高度
  'toolbar': ["undo", "redo", "|",
        "bold", "del", "italic", "quote", "ucwords", "uppercase", "lowercase", "|",
        "h1", "h2", "h3", "h5", "h6", "|",
        "list-ul", "list-ol", "hr", "|",
        "link", "reference-link", "image", "code", "preformatted-text", "code-block", "table", "datetime",
        "emoji", "html-entities", "pagebreak", "goto-line", "|",
        "help", "info",
        "||", "preview", "watch", "fullscreen"], # 自定義編輯框工具欄
  'upload_image_formats': ["jpg", "jpeg", "gif", "png", "bmp", "webp"], # 圖片上傳格式類型
  'image_floder': 'editor', # 圖片保存文件夾名稱
  'theme': 'default', # 編輯框主題 ，dark / default
  'preview_theme': 'default', # 預(yù)覽區(qū)域主題， dark / default
  'editor_theme': 'default', # edit區(qū)域主題，pastel-on-dark / default
  'toolbar_autofixed': True, # 工具欄是否吸頂
  'search_replace': True, # 是否開(kāi)啟查找替換
  'emoji': True, # 是否開(kāi)啟表情功能
  'tex': True, # 是否開(kāi)啟 tex 圖表功能
  'flow_chart': True, # 是否開(kāi)啟流程圖功能
  'sequence': True # 是否開(kāi)啟序列圖功能
}

參考

django-ckeditor

以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章: