利用Python实现漂亮的Markdown富文本app插件

django-mdeditor

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

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

功能

支持 Editor.md 大部分功能

支持标准的Markdown 文本、 CommonMark 和 GFM (GitHub Flavored Markdown) 文本;

支持实时预览、图片上传、格式化代码、搜索替换、皮肤、多语言等。

支持TOC 目录和表情;

支持 TeX, 流程图、时序图等图表扩展。

可自定义 Editor.md 工具栏。

提供了 MDTextField 字段用来支持模型字段使用。

提供了 MDTextFormField 字段用来支持 Form 和 ModelForm.

提供了 MDEditorWidget 字段用来支持 admin 自定义样式使用。

本人对于Python学习创建了一个小小的学习圈子,为各位提供了一个平台,大家一起来讨论学习Python。欢迎各位到来Python学习群:960410445一起讨论视频分享学习。Python是未来的发展方向,正在挑战我们的分析能力及对世界的认知方式,因此,我们与时俱进,迎接变化,并不断的成长,掌握Python核心技术,才是掌握真正的价值所在。

安装

pip install django-mdeditor

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

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

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

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

编写一个测试 model :

向 admin.py 中注册model:

运行 python manage.py makemigrations 和 python 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 中增加如下配置 :

本文参考:https://github.com/django-ckeditor/django-ckeditor

以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,谢谢大家对小编的支持。

  • 发表于:
  • 原文链接https://kuaibao.qq.com/s/20190118A0CRRU00?refer=cp_1026
  • 腾讯「云+社区」是腾讯内容开放平台帐号(企鹅号)传播渠道之一,根据《腾讯内容开放平台服务协议》转载发布内容。
  • 如有侵权,请联系 yunjia_community@tencent.com 删除。

扫码关注云+社区

领取腾讯云代金券