个人博客嵌入MarkDown编辑器

一、序言

开源插件markdown编辑器http://pandao.github.io/editor.md/】。

估计大家使用博客的时候对文章内容编辑头很大,对于代码高亮、格式调整、多平台兼容(csdn,简书,githup)等功能,传统的富文本虽然也很强大,但是完成这些功能似乎不太完美,而且markdown因为它的简约,扁平化,强大的多平台,极简的代码语言越来越受大家的喜爱。这里向大家推荐一个免费开源的插件,能将markdown这款强大的编辑器嵌入到自己的博客。

二、嵌入editormd

我这里是使用了widget小部件,里面有部分php模板代码,而且是采用批量加载css形式,如果你选择的不是这种,只需要正常引入js和css,然后实例化就好了。注意阅读注释!

<link rel="stylesheet" href="__STATIC__/widget/admin/editor/markdown/css/editormd.css" />
<script type="text/javascript">
var arr = [
    static_root + 'widget/admin/editor/markdown/editormd.js',
];

ob.loadMultiScripts(arr).done(function() {
    
    var editor_{$widget_data.name};
    editor_{$widget_data.name} = editormd("{$widget_data.name}", {
        width   : "100%",
        height  : 640,
        syncScrolling : "single",
        path    : static_root + 'widget/admin/editor/markdown/lib/',
        saveHTMLToTextarea : true,//这个配置,方便post提交表单,表单字段会自动加上一个字段content-html-code,形式为html格式
        /**上传图片相关配置如下*/
        imageUpload : true,
        imageFormats : ["jpg", "jpeg", "gif", "png", "bmp", "webp"],
        imageUploadURL : "{:url('widget/editormdPictureUpload')}",//注意你后端的上传图片服务地址
    });
}).fail(function(){
    
  alert('editormd加载失败...');
});
</script>
  1. 如果你需要html格式的数据,那么saveHTMLToTextarea要设置成true,这样会在post提交数据中出现content-html-code,如下所示,content必须要存,编辑时需要用来回显。我这里存的是html到文章内容,因为我网站有三种编辑器可以选择编辑文章,具体设计可根据需求来。
name: 测试
category_id: 9
describe: 
cover_id: 0
img_ids: 
file_id: 0
tagids: 
content: # 一级标题
content-html-code: <h1 id="h1-u4E00u7EA7u6807u9898"><a name="一级标题" class="reference-link"></a><span class="header-link octicon octicon-link"></span>一级标题</h1>
editor_type: 1
sort: 0
is_top: 0
id: 0
  1. 图片上传,加入实例代码中的三项配置就好imageUploadimageFormatsimageUploadURL,这里就不贴后台代码,我用的php,$_FILES['editormd-image-file']就会有值了,然后自行用后台语言处理,editormd是希望我们返回这样的代码格式:
        //期望返回值
       {
           success : 0 | 1, //0表示上传失败;1表示上传成功
           message : "提示的信息",
            url     : "图片地址" //上传成功时才返回
       }
  1. 到此为止我们网站就可以集成markdown编辑器了。效果图如下:


    编辑器效果图

三、博客文章内容页显示

这是官网提供方式进行显示,目前能满足需求,像代码高亮,流程图,表情等都能显示正常。
这里有两种方式显示内容。

  1. 我们取出的html内容!使用markdown的css 并在外层容器加入markdown-body editormd-html-preview这两个类,文字效果样式什么的都会显示,代码再用hightlight.js加载成高亮样式。

这样的形式加载快,页面几乎没缓冲,缺点的是markdown部分功能无法使用,流程图和其他功能

  1. 我们取出markdown标记语言!直接用editormd渲染,如下代码就是这种方法,也是笔者推荐。

功能强大,但是渲染过程会有样式一直在蹿的过程,持续0.5s内(根据服务器和客户端网速而定)

<article class="article-content" id="article-content">
                {if condition="$article_info.editor_type eq 1"}
                <link rel="stylesheet" href="__STATIC__/widget/admin/editor/markdown/css/editormd.preview.css" />
                    <textarea style="display:none;" placeholder="markdown语言">{$article_info.content_md}</textarea>
                <script src="__STATIC__/widget/admin/editor/markdown/lib/marked.min.js"></script>
                <script src="__STATIC__/widget/admin/editor/markdown/lib/prettify.min.js"></script>
                <script src="__STATIC__/widget/admin/editor/markdown/lib/raphael.min.js"></script>
                <script src="__STATIC__/widget/admin/editor/markdown/lib/underscore.min.js"></script>
                <script src="__STATIC__/widget/admin/editor/markdown/lib/sequence-diagram.min.js"></script>
                <script src="__STATIC__/widget/admin/editor/markdown/lib/flowchart.min.js"></script>
                <script src="__STATIC__/widget/admin/editor/markdown/lib/jquery.flowchart.min.js"></script>
                <script src="__STATIC__/widget/admin/editor/markdown/editormd.js"></script>
                <script>
                            $(function() {
                                var testEditormdView2;
                                testEditormdView2 = editormd.markdownToHTML("article-content", {
                                    htmlDecode      : "style,script,iframe",  // you can filter tags decode
                                    emoji           : true,
                                    taskList        : true,
                                    tex             : true,  // 默认不解析
                                    flowChart       : true,  // 默认不解析
                                    sequenceDiagram : true,  // 默认不解析
                                });
                            });
                </script>
                {else /}
                <pre><code class="php">echo 111</code></pre>
                    {:html_entity_decode($article_info['content'])}
                    <link rel="stylesheet" href="__STATIC__/module/resource/highlight/src/styles/default.css">
                    <script src="__STATIC__/module/resource/highlight/src/highlight.js"></script>
                    <script>hljs.initHighlightingOnLoad();</script>

                {/if}
                <p class="article-copyright hidden-xs">未经允许不得转载:<a href="{:url('index/index')}">张浩博客</a> » <a href="{:url('article/detail',['id'=>$article_info['id']])}">{$article_info.name}</a></p>
            </article>

四、总结

平时简介的代码和样式规范的文章一样重要,有了markdown我就可以丢弃鼠标,不担心样式问题,直接用简洁的标记语言专注书写核心代码。
所以我看到csdn、简书、git上都用上了markdown,我就不需要不断调格式了,一篇文章多平台发布,自己搭建的博客怎么能少了这样的神器呢,快让自己的博客也加上markdown编辑器吧!

欢迎关注我的博客 www.zhanghao520.com,更多技术问题一起研究!

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,033评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,725评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,473评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,846评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,848评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,691评论 1 282
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,053评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,700评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,856评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,676评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,787评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,430评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,034评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,990评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,218评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,174评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,526评论 2 343