认识django-mdeditor

Markdown是一种可以使用普通文本编辑器编写的标记语言,通过简单的标记语法,它可以使普通文本内容具有一定的格式。它允许人们使用易读易写的纯文本格式编写文档,然后转换成格式丰富的HTML页面,Markdown文件的后缀名便是“.md”

Github地址:https://github.com/pylixm/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 自定义样式使用。
  • ...

访问官网https://pandao.github.io/editor.md/examples/index.html 可以看到完整的功能教程,用js脚本进行功能配置

快速入门

安装

pip install django-mdeditor

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

    INSTALLED_APPS = [
        ...
        'mdeditor',
    ]

在 settings 中添加媒体文件的路径配置: #媒体文件 MEDIA_URL = '/static/media/' MEDIA_ROOT = os.path.join(BASE_DIR, 'static/media/') 可以在你项目根目录下创建 目录,用于存放上传的图片。 也可以利用blog/model中img的配置自定义图片上传的地址: img = models.ImageField(upload_to='media/article', default='media/artile/default.png', storage=ImageStorage())

在你项目的根 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)

如果静态文件还是没有还是没有预览,也可以通过,复制mdeditor的静态文件到博客的静态文件static根目录中:

在env/site-package/找到mdeditor,下面有static根目录,将static下的meditor复制到博客的static根目录中

编写一个测试 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后台,点击 '添加'操作,你会看到如下界面。

到此,你已经初步体验了 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  # 是否开启序列图功能
}

2019-11-22 08:23:32 星期五

选择python的markdown包给进行前端的md2html转化,还是使用mdeditor的js文件呢

既然我们已经引用了mdeditor的静态文件,可以感受到这个包的强大功能。 传统的我们一般使用mardkwon配合emoji、Pygments 来处理后端的md数据: 2019-11-22 08:23:33 星期五

选择python的markdown包给进行前端的md2html转化

注意编写markdown的extension参数

post.content =markdown.markdown(post.content.replace("\r\n",'\n'),extensions['markdown.extensions.extra','markdown.extensions.codehilite','markdown.extensions.toc', ],safe_mode=True,enable_attributes=False)

并且有些功能喝问题需要自己处理 - markdow换行问题

就是markdown的换行问题,在前端界面换行显示有问题,并没有br标签,这是因为在markdown语法中两个空格加一个换行才是换行,或者两个换行才是一个换行

可使用post.content.replace(“\r\n”, ’ \n’)解决,把换行符替换成两个空格+换行符,这样经过markdown转换后才可以转成前端的br标签

  • 添加代码高亮: 安装

pip install Pygments

用pygments生成代码高亮的code.css文件

pygmentize -S default -f html -a .codehilite > code.css

将code.css文件移动到static/css中并在再html中调用

<link rel="stylesheet" type="text/css" href="{% static 'css/code.css' %}">

2019-11-22 08:23:30 星期五

用editor.md项目配置js文件进行前端md2html转换

  • 在template/article.hmtml中加入mdeditor的css、js文件
    <!-- 评论区 -->
    <link href="{% static 'comment/css/base_comment.css' %}" rel="stylesheet">
    <link href="{% static 'comment/css/notification.css' %}" rel="stylesheet">
    <!-- 文本区 -->
    <link href="{% static 'mdeditor/css/editormd.css' %}" rel="stylesheet" type="text/css">
    。。。
    <script src="{% static 'comment/js/notification.js' %}"></script>
    <script src="{% static 'comment/js/editor.js' %}"></script>
    <script src="{% static 'comment/js/activate-power.js' %}"></script>
    <!-- mdeditor -->
    <script src="{% static 'mdeditor/js/lib/marked.min.js' %}"></script>
    <script src="{% static 'mdeditor/js/editormd.min.js' %}"></script>
    <!-- 绘制序列图 -->
    <script src="{% static 'mdeditor/js/lib/sequence-diagram.min.js' %}"></script>
    <!-- 绘制流程图 -->
    <!-- <script src="{% static 'mdeditor/js/lib/flowchart.min.js' %}"></script> -->
    <!-- <script src="{% static 'mdeditor/js/lib/jquery.flowchart.min.js' %}"></script> -->

js文件这么多,我们怎么选择呢?

选择引用的静态文件还是要根据自己的需求,代码中已经添加了一些注释。

哪些静态文件对应哪些功能呢?

访问官网https://pandao.github.io/editor.md/examples/index.html 可以看到完整的功能教程,用js脚本进行功能配置:

  • 快速配置,后端数据传入到article.html中:

    <!-- 文章内容 -->
    <div class="">
     <div id="test-editormd-view">
        <textarea id="append-test" style="display:none;">  {{ article.body|safe }}</textarea>
    </div>
  • 调用editor的配置文件:

  • 配置结束,基本上后端的{{ article.body|safe }}md数据就可以在前端用js包进行处理了。

原创文章,转载请注明出处:https://boywithacoin.cn/article/django-mdeditorhou-tai-nei-qian-mdwen-zhang-bian-ji-editor-mdkai-yuan-xiang-mu/