Markdown编辑器Editor.md集成使用

待我称王封你为后i 2021-06-26 16:06 473阅读 0赞

## 一、下载插件 ##

项目地址：[http://pandao.github.io/editor.md/][http_pandao.github.io_editor.md]  
下载安装包后放在相应的目录中并引用

## 二、在自己的页面中加上对应的id ##

## 三、js代码 ##

主要就是说这个就是代码

var testEditor;
    testEditor = editormd("test-editormd", { 
         placeholder:'本编辑器支持Markdown编辑，左边编写，右边预览',  //默认显示的文字，这里就不解释了
         width: "90%",
         height: 640,
         syncScrolling: "single",  
         path: "lib/js/editor.md-master/lib/",   //你的path路径（原资源文件中lib包在我们项目中所放的位置）
         theme: "dark",//工具栏主题
         previewTheme: "dark",//预览主题
         editorTheme: "pastel-on-dark",//编辑主题
         saveHTMLToTextarea: true,
         emoji: false,
         taskList: true, 
         tocm: true,         // Using [TOCM]
         tex: true,                   // 开启科学公式TeX语言支持，默认关闭
         flowChart: true,             // 开启流程图支持，默认关闭
         sequenceDiagram: true,       // 开启时序/序列图支持，默认关闭,
         toolbarIcons : function() {   //自定义工具栏，后面有详细介绍
             return editormd.toolbarModes['simple']; // full, simple, mini
          },
    });
    //上面的挑有用的写上去就行

以下是完整的配置

<!DOCTYPE html>
    <html lang="zh">
        <head>
            <meta charset="utf-8" />
            <title>Full example - Editor.md examples</title>
            <link rel="stylesheet" href="css/style.css" />
            <link rel="stylesheet" href="../css/editormd.css" />   
            <link rel="shortcut icon" href="https://pandao.github.io/editor.md/favicon.ico" type="image/x-icon" />
            <style> /*.editormd-preview-theme-dark { color: #777; background:#2C2827; } .editormd-preview-theme-dark .editormd-toc-menu > .markdown-toc { background:#fff; border:none; } .editormd-preview-theme-dark .editormd-toc-menu > .markdown-toc h1{ border-color:#ddd; } .editormd-preview-theme-dark .markdown-body h1, .editormd-preview-theme-dark .markdown-body h2, .editormd-preview-theme-dark .markdown-body hr { border-color: #222; } .editormd-preview-theme-dark .editormd-preview-container blockquote { color: #555; border-color: #333; background: #222; padding: 0.5em; } .editormd-preview-theme-dark .editormd-preview-container abbr { background:#ff9900; color: #fff; padding: 1px 3px; border-radius: 3px; } .editormd-preview-theme-dark .editormd-preview-container code { background: #5A9600; color: #fff; border: none; padding: 1px 3px; border-radius: 3px; } .editormd-preview-theme-dark .editormd-preview-container table { border: none; } .editormd-preview-theme-dark .editormd-preview-container .fa-emoji { color: #B4BF42; } .editormd-preview-theme-dark .editormd-preview-container .katex { color: #FEC93F; } .editormd-preview-theme-dark [class*=editormd-logo] { color: #2196F3; } .editormd-preview-theme-dark .sequence-diagram text { fill: #fff; } .editormd-preview-theme-dark .sequence-diagram rect, .editormd-preview-theme-dark .sequence-diagram path { color:#fff; fill : #64D1CB; stroke : #64D1CB; } .editormd-preview-theme-dark .flowchart rect, .editormd-preview-theme-dark .flowchart path { stroke : #A6C6FF; } .editormd-preview-theme-dark .flowchart rect { fill: #A6C6FF; } .editormd-preview-theme-dark .flowchart text { fill: #5879B4; }*/ </style>     
        </head>
        <body>
            <div id="layout">
                <header>
                    <h1>完整示例</h1>
                    <p>Full example</p>
                    <ul style="margin: 10px 0 0 18px;">
                        <li>Enable HTML tags decode</li>
                        <li>Enable TeX, Flowchart, Sequence Diagram, Emoji, FontAwesome, Task lists</li>
                        <li>Enable Image upload</li>
                        <li>Enable [TOCM], Search Replace, Code fold</li>
                    </ul>            
                </header>
                <div class="btns">
                    <button id="goto-line-btn">Goto line 90</button>
                    <button id="show-btn">Show editor</button>
                    <button id="hide-btn">Hide editor</button>
                    <button id="get-md-btn">Get Markdown</button>
                    <button id="get-html-btn">Get HTML</button>
                    <button id="watch-btn">Watch</button>
                    <button id="unwatch-btn">Unwatch</button>
                    <button id="preview-btn">Preview HTML (Press Shift + ESC cancel)</button>
                    <button id="fullscreen-btn">Fullscreen (Press ESC cancel)</button>
                    <button id="show-toolbar-btn">Show toolbar</button>
                    <button id="close-toolbar-btn">Hide toolbar</button>
                    <button id="toc-menu-btn">ToC Dropdown menu</button>
                    <button id="toc-default-btn">ToC default</button>
                </div>
                <div id="test-editormd"></div>
            </div>
            <script src="js/jquery.min.js"></script>
            <script src="../editormd.js"></script>   
            <script type="text/javascript"> var testEditor; $(function() { $.get('test.md', function(md){ testEditor = editormd("test-editormd", { width: "90%", height: 740, path : '../lib/', theme : "dark", previewTheme : "dark", editorTheme : "pastel-on-dark", markdown : md, codeFold : true, //syncScrolling : false, saveHTMLToTextarea : true, // 保存 HTML 到 Textarea searchReplace : true, //watch : false, // 关闭实时预览 htmlDecode : "style,script,iframe|on*", // 开启 HTML 标签解析，为了安全性，默认不开启 //toolbar : false, //关闭工具栏 //previewCodeHighlight : false, // 关闭预览 HTML 的代码块高亮，默认开启 emoji : true, taskList : true, tocm : true, // Using [TOCM] tex : true, // 开启科学公式TeX语言支持，默认关闭 flowChart : true, // 开启流程图支持，默认关闭 sequenceDiagram : true, // 开启时序/序列图支持，默认关闭, //dialogLockScreen : false, // 设置弹出层对话框不锁屏，全局通用，默认为true //dialogShowMask : false, // 设置弹出层对话框显示透明遮罩层，全局通用，默认为true //dialogDraggable : false, // 设置弹出层对话框不可拖动，全局通用，默认为true //dialogMaskOpacity : 0.4, // 设置透明遮罩层的透明度，全局通用，默认值为0.1 //dialogMaskBgColor : "#000", // 设置透明遮罩层的背景颜色，全局通用，默认为#fff imageUpload : true, imageFormats : ["jpg", "jpeg", "gif", "png", "bmp", "webp"], imageUploadURL : "./php/upload.php", onload : function() { console.log('onload', this); //this.fullscreen(); //this.unwatch(); //this.watch().fullscreen(); //this.setMarkdown("#PHP"); //this.width("100%"); //this.height(480); //this.resize("100%", 640); } }); }); $("#goto-line-btn").bind("click", function(){ testEditor.gotoLine(90); }); $("#show-btn").bind('click', function(){ testEditor.show(); }); $("#hide-btn").bind('click', function(){ testEditor.hide(); }); $("#get-md-btn").bind('click', function(){ alert(testEditor.getMarkdown()); }); $("#get-html-btn").bind('click', function() { alert(testEditor.getHTML()); }); $("#watch-btn").bind('click', function() { testEditor.watch(); }); $("#unwatch-btn").bind('click', function() { testEditor.unwatch(); }); $("#preview-btn").bind('click', function() { testEditor.previewing(); }); $("#fullscreen-btn").bind('click', function() { testEditor.fullscreen(); }); $("#show-toolbar-btn").bind('click', function() { testEditor.showToolbar(); }); $("#close-toolbar-btn").bind('click', function() { testEditor.hideToolbar(); }); $("#toc-menu-btn").click(function(){ testEditor.config({ tocDropdown : true, tocTitle : "目录 Table of Contents", }); }); $("#toc-default-btn").click(function() { testEditor.config("tocDropdown", false); }); }); </script>
        </body>
    </html>

综上所述一个编辑器就诞生了，下面有个小知识点。

testEditor.getMarkdown();
    // 在js中调用getMarkdown这个方法可以获得Markdown格式的文本。

## 四、页面展示`Markdown`文档 ##

后台给我们的文档我们要展示成转换后的样子不能一大堆符号摆在页面上是吧，也不好看呀，所以下面放上展示代码需要的东东。

首先引入必要JS（下面不是所有的都必要）

页面的div

js代码

testEditor = editormd.markdownToHTML("test-editormd", { 
          markdown:$scope.apidetails.content,
          htmlDecode      : "style,script,iframe",  // you can filter tags decode
          emoji           : true,
          taskList        : true,
          tex             : true,  // 默认不解析
          flowChart       : true,  // 默认不解析
          sequenceDiagram : true,  // 默认不解析
    });

## 五、自定义工具栏 ##

工具栏分为三组，`full, simple, mini`这三个，可以选择，如果想更加自由选你所需，就可以用下面的代码，也可以看看官网的示例

toolbarIcons : function() { 
                // Or return editormd.toolbarModes[name]; // full, simple, mini
                // Using "||" set icons align right.
                return ["undo", "redo", "|", "bold", "hr"]
            },

具体每一个标签代表的什么含义可以对照整个工具栏自己对一下，下面是他的源码

t.toolbarModes={ 
        full:["undo","redo","|","bold","del","italic","quote","ucwords","uppercase","lowercase","|","h1","h2","h3","h4","h5","h6","|","list-ul","list-ol","hr","|","link","reference-link","image","code","preformatted-text","code-block","table","datetime","emoji","html-entities","pagebreak","|","goto-line","watch","preview","fullscreen","clear","search","|","help","info"],
        simple:["undo","redo","|","bold","del","italic","quote","uppercase","lowercase","|","h1","h2","h3","h4","h5","h6","|","list-ul","list-ol","hr","|","watch","preview","fullscreen","|","help","info"],
        mini:["undo","redo","|","watch","preview","|","help","info"]
    }

## 六、效果图 ##

![在这里插入图片描述][2019051811360344.png]

[http_pandao.github.io_editor.md]: http://pandao.github.io/editor.md/
[2019051811360344.png]: /images/20210626/b780089ee116421590407f3d4278d1eb.png