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

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

注: 关于Markdown页面渲染问题,建议后端渲染。因Editor.md 已长时间不更新有些bug和兼容性问题需要自己调试,当然前端同学可自行选择。

功能

  • 支持 Editor.md 大部分功能
    • 支持标准的Markdown 文本、 CommonMark 和 GFM (GitHub Flavored Markdown) 文本;
    • 支持实时预览、图片上传、格式化代码、搜索替换、皮肤、多语言等。
    • 支持TOC 目录和表情;
    • 支持 TeX, 流程图、时序图等图表扩展。
  • 可自定义 Editor.md 工具栏。
  • 提供了 MDTextField 字段用来支持模型字段使用。
  • 提供了 MDTextFormField 字段用来支持 FormModelForm.
  • 提供了 MDEditorWidget 字段用来支持 admin 自定义样式使用。
给 Django 加一个 markdown  editor Django-mdeditor-新乡seo|网站优化,网站建设_微信公众号:zeropython—昊天博客

快速入门

  • 安装

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

  • settings 中添加媒体文件的路径配置:

在你项目根目录下创建 uploads/editor 目录,用于存放上传的图片。

  • 在你项目的根 urls.py 中添加扩展url和媒体文件url:

  • 编写一个测试 model :

  • admin.py 中注册model:

  • 运行 python manage.py makemigrationspython manage.py migrate 来创建你的model 数据库表.

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

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

用法说明

在model 中使用 Markdown 编辑字段

在model 中使用 Markdown 编辑字段,我们只需要将 model 的TextField 替换成MDTextField 即可。

在后台admin中,会自动显示 markdown 的编辑富文本。

在前端 template 中使用时,可以这样用:

在 Form 中使用 markdown 编辑字段

在 Form 中使用 markdown 编辑字段,使用 MDTextFormField 代替 forms.CharField, 如下:

ModelForm 可自动将model 对应的字段转为 form字段, 可正常使用:

在 admin 中使用 markdown 小组件

在 admin 中使用 markdown 小组件,如下:

自定义工具栏

settings 中增加如下配置 :