前言

flask-admin 算是一个很不错的 flask 后台管理了,用它来做博客系统的管理后端再合适不过了,节约时间成本,避免重复造轮子,但是作为一个程序员,写文章怎么可以没有 markdown 呢? 现在让我们尝试一下让 flask-admin 支持 markdown 吧.

实践

Flask-PageDown

这个库是对 Pagedown 的封装,将其集成到了Flask-WTF表单中了。具体内容可以去它的 github 仓库看一下: Flask-PageDown

优缺点

优点:

配置简单
对 flask-admin 的改动较小

缺点:

无法实现对代码的高亮
生成的编辑器是上下布局的,不太美观

使用方法

安装和配置

通过 pip 进行安装:

pip install flask-pagedown

然后在项目中初始化:

from flask_pagedown import PageDown

app = Flask(__name__)

pagedown = PageDown(app)

当然也可以通过 init_app(app) 的方式进行初始化

from flask import Flask

from flask_pagedown import PageDown

pagedown = PageDown()

def create_app(config_name):

    app = Flask(__name__, static_folder='static', static_url_path='')

    app.config.from_object(config[config_name])

    # 省略部分代码

    pagedown.init_app(app)

    return app

这个编辑器还依赖两个 js 文件,所以还需要在我们的对应的模板中添加进去相应的方法:

<html>

    <head>

    {{ pagedown.html_head() }}

    </head>

    <body>

    ...

    </body>

</html>

默认情况下这两个 js 是通过 CDN 加载的,也就意味着你的服务器需要可以访问网络,如果只想通过本地就可以访问的话,很简单把这两个 js 文件下载下来,然后将 pagedown.html_head() 替换成两个文件的本地路径就可以了. 两个文件的下载地址: Markdown.Converter,

Markdown.Sanitizer

新增自定义的 ModelView

flask-admin 支持自定义的 ModelView, 这是我们可以实现这个功能的基础.

class PeachPostView(ModelView):

    form_overrides = {

        'content': PageDownField

    }

    def __init__(self, model, session, **kwargs):

        super(PeachPostView, self).__init__(model, session, **kwargs)

    # 省略部分代码

最后在我们的 flask-admin 给我们需要 markdown 编辑器的 model 添加上自定义的 ModelView 就可以了.

# 省略部分代码

admin.add_view(PeachPostView(Post, db.session, endpoint='AdminPost'))

完整代码可以查看 use:使用 flask-pagedown 作为 markdown 编辑器

最终的效果图:

使用开源的 markdown 编辑器

没错,这个方法就比较自由了,找自己喜欢的 markdown 编辑器然后集成进去. 这里我最终选择了 [editor.md]

(https://github.com/pandao/editor.md.git) 这个开源编辑器,这个好像很久没维护了,但是颜值挺高的了,就决定是它了.

优缺点

优点:

优点很明星,颜值高,满足我对 markdown 的所有需求了,支持代码高亮.

缺点:

对 flask-admin 的改动较多,需要自己写的部分比较多.

使用方法

下载 editor.md 插件

插件下载很简单,从官网上或者 github 上下载, 下载完成后,我这里将 editor.md 下载的文件保存到 static 的 plugin 的目录下了.

覆盖 flask-admin 原有文件

这里由于我们需要使用插件,所以我们需要对 flask-admin 原有的 create.html 和 edit.html 文件进行重写.

在 templates 目录下新建 admin 目录
在 admin 目录下创建 model 目录, 并新增 peach-post-create.html, peach-post-edit.html 文件,将 flask-admin 对应的 create.html 和 edit.html 内容复制进去.
在 admin 目录下新增 peach-base.html 和 peach-lib.html 文件,将 flask-admin 对应的 base.html 和 lib.html 文件复制进去

tip: 上述说所的 flask-admin 的内容,均在你的开发环境中找到 flask-admin 的库所在目录,然后需要复制的文件在: flask_admin\templates\bootstrap3\admin 下

然后配置,使其访问我们指定的文件

# 自定义的 modelview

class PeachPostView(ModelView):

    # 指定访问文件

    create_template = 'admin/model/peach-post-create.html'

    edit_template = 'admin/model/peach-post-edit.html'

    def __init__(self, model, session, **kwargs):

        super(PeachPostView, self).__init__(model, session, **kwargs)

# 指定 base_template 文件

admin = Admin(name=name, template_mode=template_mode,index_view=PeachAdminIndexView(), base_template='admin/peach-base.html')

# 省略部分代码

admin.add_view(PeachPostView(Post, db.session, endpoint='AdminPost'))

修改文件, 支持 markdown

动手修改文件的之前,我们需要先了解一下 flask-amdmin 原有的文件是什么样子的,然后才能正确的修改,这里以 create.html 为例子,截取关键代码.

# create.html

{% import 'admin/lib.html' as lib with context %}

# ...

{% block edit_form %}

    {{ lib.render_form(form, return_url, extra(), form_opts) }} # 使用了 lib 中的函数,看一下这个函数

{% endblock %}

# lib.html

{% macro render_form(form, cancel_url, extra=None, form_opts=None, action=None, is_modal=False) -%}

    {% call form_tag(action=action) %}

        {{ render_form_fields(form, form_opts=form_opts) }}  # 重点是表单渲染,再看一下 render_form_fields 函数

        {{ render_form_buttons(cancel_url, extra, is_modal) }}

    {% endcall %}

{% endmacro %}

{% macro render_form_fields(form, form_opts=None) %}

    # 省略部分代码

          {{ render_field(form, f, kwargs) }}  # 看一下 render_field 这个函数

{% endmacro %}

{% macro render_field(form, field, kwargs={}, caller=None) %}

  {% set direct_error = h.is_field_error(field.errors) %}

  <div class="form-group{{ ' has-error' if direct_error else '' }}">

    <label for="{{ field.id }}" class="col-md-2 control-label">{{ field.label.text }}

        {% if h.is_required_form_field(field) %}

          <strong style="color: red">*</strong>

        {%- else -%}

          &nbsp;

        {%- endif %}

    </label>

    <div class="{{ kwargs.get('column_class', 'col-md-10') }}">

      {% set _dummy = kwargs.setdefault('class', 'form-control') %}

      {{ field(**kwargs)|safe }}

      {% if field.description %}

      <p class="help-block">{{ field.description|safe }}</p>

      {% endif %}

      {% if direct_error %}

        <ul class="help-block input-errors">

        {% for e in field.errors if e is string %}

          <li>{{ e }}</li>

        {% endfor %}

        </ul>

      {% endif %}

    </div>

    {% if caller %}

      {{ caller(form, field, direct_error, kwargs) }}

    {% endif %}

  </div>

{% endmacro %}

通过上述 flask-admin 源码的浏览,我们不难发现,最终的渲染最核心的函数就是 lib.html 中的 render_field 函数, 要达到我们的目的,我们就需要对这个函数进行一点的修改了.由于我们只需要对数据库模型的某个字段支持 markdown 就可以了,所以需要我们可以通过 field.id == '字段名' 的方法去判断,从而让他支持 markdown.

为了更好的理解接下来的代码,我们对 editor.md 的使用做一个简单的说明:

<link rel="stylesheet" href="editormd.min.css" />

<div id="editormd">

    <textarea style="display:none;">### Hello Editor.md !</textarea>

</div>

<script src="jquery.min.js"></script>

<script src="editormd.min.js"></script>

<script type="text/javascript">

    $(function() {

        var editor = editormd("editormd", {

            path : "../lib/" // Autoload modules mode, codemirror, marked... dependents libs path

        });

        /*

        // or

        var editor = editormd({

            id   : "editormd",

            path : "../lib/"

        });

        */

    });

</script>

说明完了怎么使用 editor.md,我们来说一下我们最终的思路, 通过字段名去判断,然后符合添加的情况下,新建一个 div, id 为 editor,然后在 peach-post-create.html 按照 editor.md 的使用方法渲染.说完了思路,接下来就看代码.

修改 peach-lib.html 和 peach-post-create.html 文件

# peach-lib.html

{% macro render_field(form, field, kwargs={}, caller=None) %}

  {% set direct_error = h.is_field_error(field.errors) %}

  <div class="form-group{{ ' has-error' if direct_error else '' }}">

    <label for="{{ field.id }}" class="col-md-2 control-label">{{ field.label.text }}

        {% if h.is_required_form_field(field) %}

          <strong style="color: red">*</strong>

        {%- else -%}

          &nbsp;

        {%- endif %}

    </label>

    <div class="{{ kwargs.get('column_class', 'col-md-10') }}">

      {% set _dummy = kwargs.setdefault('class', 'form-control') %}

      {% if field.id == 'content' %} # 符合条件新建一个 div

        <div id='editormd'>

            {{ field(**kwargs)|safe }}

        </div>

      {% else %}

        {{ field(**kwargs)|safe }}

      {% endif %}

      {% if field.description %}

      <p class="help-block">{{ field.description|safe }}</p>

      {% endif %}

      {% if direct_error %}

        <ul class="help-block input-errors">

        {% for e in field.errors if e is string %}

          <li>{{ e }}</li>

        {% endfor %}

        </ul>

      {% endif %}

    </div>

    {% if caller %}

      {{ caller(form, field, direct_error, kwargs) }}

    {% endif %}

  </div>

{% endmacro %}

# peach-post-create.html

{% extends 'admin/master.html' %}

{% import 'admin/peach-lib.html' as lib with context %}

{% from 'admin/peach-lib.html' import extra with context %} {# backward compatible #}

# 省略部分代码

  {{ super() }}

  {{ lib.form_css() }}

  <link href="{{ url_for('static', filename='plugins/editor.md/css/editormd.min.css')}}" rel='stylesheet'>

{% endblock %}

# 省略部分代码

{% block tail %}

  {{ super() }}

  {{ lib.form_js() }}

  <script src="{{ url_for('static', filename='plugins/editor.md/editormd.js')}}"></script>

  <script type="text/javascript">

    $(function() {

        var editor = editormd("editormd", {

            path : "/plugins/editor.md/lib/",

            height  : 640

        });

    });

  </script>

{% endblock %}

修改 modelview

class PeachPostView(ModelView):

    # 省略部分代码

    create_template = 'admin/model/peach-post-create.html'

admin = Admin(name=name, template_mode=template_mode,index_view=PeachAdminIndexView(), base_template='admin/peach-base.html')

# 省略部分代码

admin.add_view(PeachPostView(Post, db.session, endpoint='AdminPost'))

完整代码可以查看 add:使用 editor.md 编辑器

最后看一下效果图:

最后

到此大功告成,欢迎大家关注我的公共号-Leetao, 偶尔分享 flask 之外的知识.

让Flask-admin支持markdown编辑器的更多相关文章

在MAC OS 下配置python + Flask ,并支持pyCharm编辑器
原创咯- flask是一个micro framework ,伸缩性很强.可以部署到openshift 的PAAS里.这个框架上手非常快.喜欢的可以试试. 若实在MAC里,python已经默认安装了.1 ...
Django集成Markdown编辑器【附源码】
专注内容写作的你一定不要错过markdown 简单介绍 markdown是一种标记语言,通过简单的标记语法可以使普通的文本内容具有一定的格式,使用非常简单,学习成本极低目前各大Blog平台都已支持m ...
一个支持实时预览的在线 Markdown 编辑器 - Markdoc
最近组内需要为一些项目和系统写文档,发表在公司内的文档平台上,这个平台并不支持markdown,所以打算做一个在线markdown编辑器,支持实时预览,并且可以很容易的迁移发表到公司文档平台上,所以就 ...
公众号在线Markdown编辑器，支持公式
公众号排版不支持Markdown,用自带的富文本编辑器排版出来的格式十分丑陋,尤其是公式,竟然连"Mathjax"都不支持,但好在支持"带格式复制",也即可以将 ...
【完全开源】Django多人博客系统——支持MarkDown和tinyMce
目录说明功能如何使用说明这是一个用Django开发的多人博客系统,功能简单,但完全满足公司内部或个人的博客使用需求.支持普通富文本编辑器(tinyMCE)和MarkDown编辑器由于嫌弃D ...
thinkphp5使用Markdown编辑器Editor.md并上传图片
Editor.md官网:https://pandao.github.io/editor.md/index.html 下载后解压放到项目内,和引入ueditor差不多 1.引入项目资源 <!--m ...
好用的Markdown编辑器一览 readme.md 编辑查看
https://github.com/pandao/editor.md https://pandao.github.io/editor.md/examples/index.html Editor.md ...
mac好用的markdown编辑器
在刚开始接触markdown的时候,就被吸引了.此后一直在找贴心的好用的markdown编辑器.印象笔记和马克飞象配合着用也是挺好的,唯一的缺点就是比较封闭,发个笔记的链接给同学,还得注册才能看,导致 ...
破解 Windows 下Markdown 编辑器 MarkdownPad 2
MarkdownPad 是 Windows 平台下一款优秀的 Markdown 编辑器,本文简单介绍 Markdown 以及使用一种方法破解 MarkdownPad 使其升级到专业版.该方法仅限于教育 ...

随机推荐

Msys2：windows下好用的unix模拟器
msys2是基于mingw的bash模拟器,他为在windows下使用类似unix的环境提供了方便.同时,他还是基于mingw的,所以,他生成的也是原生的windows程序. msys2官方网站是:h ...
winphone开发环境配置
环境:操作系统win7 要进行winphone开发,必须进行一些环境的配置.下面是我的一些配置总结. 1.操作系统 winphone开发仅仅能在win8下开发.所以首先得安装win8.能够使用nt6 ...
MySql 触发器同步备份数据表记录
添加记录到新记录表 DELIMITER $$ USE `DB_Test`$$ CREATE /*!50017 DEFINER = 'root'@'%' */ TRIGGER `InsertOPM_Al ...
Spark性能优化指南——基础篇转
前言在大数据计算领域,Spark已经成为了越来越流行.越来越受欢迎的计算平台之一.Spark的功能涵盖了大数据领域的离线批处理.SQL类处理.流式/实时计算.机器学习.图计算等各种不同类型的计算操作 ...
centos启动zookeeper
切换到zookeeper的bin目录下,执行 ./zkServer.sh start
js正则表达式判断一个字符串是否是正确的有数字和小数点组成的金钱形式和判读数值类型的正则表达式
function checkRates(str){ var re = /^(([1-9][0-9]*\.[0-9][0-9]*)|([0]\.[0-9][0-9]*)|([1-9][0-9]*) ...
【Java】创建线程对象两种方式
1.继承Thread类,重载run方法: Thread t = new Thread(new Runnable() { @Override public void run() { // TODO Au ...
关于使用samba用户的权限设置
首先要保证你的samba安装并配置好,关于安装和配置samba请参考此文章http://blog.csdn.net/linglongwunv/archive/2010/01/19/5212875.as ...
Android——基于监听器的事件处理（转）
事件,我们并不陌生! 所有的基于UI的应用程序,事件都变得不可或缺!试想一下,如果我们做的程序单击按钮和其它控件都没有反应,那么就如同一个人在这个世界上听不到声音一样! Android为我们提供了两种 ...
官网下载到离线的Adobe Acrobat Reader DC
Adobe 官方 FTP :ftp://ftp.adobe.com/ Adobe Acrobat Reader DC 下载目录:ftp://ftp.adobe.com/pub/adobe/reader ...

让Flask-admin支持markdown编辑器

前言

实践

Flask-PageDown

优缺点

使用方法

安装和配置

新增自定义的 ModelView

使用开源的 markdown 编辑器

优缺点

使用方法

下载 editor.md 插件

覆盖 flask-admin 原有文件

修改文件, 支持 markdown

最后

让Flask-admin支持markdown编辑器的更多相关文章

随机推荐

热门专题