欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

漂亮的Django Markdown富文本app插件的实现

程序员文章站 2022-11-14 20:49:13
django-mdeditor github地址:欢迎试用,star收藏! django-mdeditor 是基于editor.md 的一个 django mark...

django-mdeditor

github地址:欢迎试用,star收藏!

django-mdeditor 是基于editor.md 的一个 django markdown 文本编辑插件应用。

django-mdeditor 的灵感参考自伟大的项目.

功能

  • 支持 editor.md 大部分功能
    • 支持标准的markdown 文本、 commonmark 和 gfm (github flavored markdown) 文本;
    • 支持实时预览、图片上传、格式化代码、搜索替换、皮肤、多语言等。
    • 支持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/'

在你项目根目录下创建 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 来创建你的model 数据库表.

登录 django admin后台,点击 '添加'操作,你会看到如下界面。

漂亮的Django Markdown富文本app插件的实现

到此,你已经初步体验了 djang-mdeditor ,接下来详细看下他的其他使用吧。

用法说明

在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 对应的字段转为 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%', # 自定义编辑框宽度
  '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', # 预览区域主题, dark / default
  'editor_theme': 'default', # edit区域主题,pastel-on-dark / default
  'toolbar_autofixed': true, # 工具栏是否吸顶
  'search_replace': true, # 是否开启查找替换
  'emoji': true, # 是否开启表情功能
  'tex': true, # 是否开启 tex 图表功能
  'flow_chart': true, # 是否开启流程图功能
  'sequence': true # 是否开启序列图功能
}

参考


以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。