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

django-mdeditor
前端

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

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

功能
github

支持 Editor.md 大部分功能数据库

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

支持实时预览、图片上传、格式化代码、搜索替换、皮肤、多语言等。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

以上就是这篇文章的所有内容了,但愿本文的内容对你们的学习或者工做具备必定的参考学习价值,谢谢你们对小编的支持。