django-mdeditor
Github地址:https://github.com/pylixm/django-mdeditor 歡迎試用，star收藏预麸！
Django-mdeditor 是基于 Editor.md 的一個 django Markdown 文本編輯插件應(yīng)用瞪浸。
Django-mdeditor 的靈感參考自偉大的項目 django-ckeditor.
功能
- 支持 Editor.md 大部分功能
- 支持標(biāo)準(zhǔn)的Markdown 文本、 CommonMark 和 GFM (GitHub Flavored Markdown) 文本;
- 支持實時預(yù)覽吏祸、圖片上傳对蒲、格式化代碼、搜索替換贡翘、皮膚蹈矮、多語言等。
- 支持TOC 目錄和表情鸣驱；
- 支持 TeX, 流程圖泛鸟、時序圖等圖表擴展。
- 可自定義 Editor.md 工具欄踊东。
- 提供了
MDTextField字段用來支持模型字段使用北滥。 - 提供了
MDTextFormField字段用來支持Form和ModelForm. - 提供了
MDEditorWidget字段用來支持admin自定義樣式使用。
快速入門
- 安裝
pip install django-mdeditor
- 在
settings配置文件INSTALLED_APPS中添加mdeditor:
INSTALLED_APPS = [
...
'mdeditor',
]
- 在
settings中添加媒體文件的路徑配置:
MEDIA_ROOT = os.path.join(BASE_DIR, 'uploads')
MEDIA_URL = '/media/'
在你項目根目錄下創(chuàng)建 uploads/editor 目錄闸翅，用于存放上傳的圖片再芋。
- 在你項目的根
urls.py中添加擴展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)
- 編寫一個測試 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中注冊model:
from django.contrib import admin
from . import models
admin.site.register(models.ExampleModel)
- 運行
python manage.py makemigrations和python manage.py migrate來創(chuàng)建你的model 數(shù)據(jù)庫表. - 登錄 django admin后臺，點擊 '添加'操作坚冀，你會看到如下界面济赎。
[圖片上傳失敗...(image-511007-1566372330965)]
到此，你已經(jīng)初步體驗了 djang-mdeditor 遗菠，接下來詳細(xì)看下他的其他使用吧联喘。
用法說明
在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()
在后臺admin中，會自動顯示 markdown 的編輯富文本叭喜。
在前端 template 中使用時贺拣，可以這樣用：
{% 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 可自動將model 對應(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, # 是否開啟查找替換
'emoji': True, # 是否開啟表情功能
'tex': True, # 是否開啟 tex 圖表功能
'flow_chart': True, # 是否開啟流程圖功能
'sequence': True # 是否開啟序列圖功能
}
