首页 > 编程 > Java > 正文

SpringBoot使用Editor.md构建Markdown富文本编辑器示例

2019-11-26 10:09:39
字体:
来源:转载
供稿:网友

Markdown是一种可以使用普通文本编辑器编写的标记语言,通过简单的标记语法,它可以使普通文本内容具有一定的格式。

前言

Editor.md 是一款开源的、可嵌入的 Markdown 在线编辑器(组件),基于 CodeMirror、jQuery 和 Marked 构建。本章将使用SpringBoot整合Editor.md构建Markdown编辑器。

下载插件

项目地址:Editor.md

解压目录结构:

配置Editor.md

将exapmles文件夹中的simple.html放置到项目中,并配置对应的css和js文件

配置编辑器

...... <script src="${re.contextPath}/jquery.min.js"></script>  <script src="${re.contextPath}/editor/editormd.min.js"></script>  <link rel="stylesheet" href="${re.contextPath}/editor/css/style.css" rel="external nofollow" />  <link rel="stylesheet" href="${re.contextPath}/editor/css/editormd.css" rel="external nofollow" rel="external nofollow" />  <link rel="shortcut icon" href="https://pandao.github.io/editor.md/favicon.ico" rel="external nofollow" type="image/x-icon"/>......<!-- 存放源文件用于编辑 --> <textarea style="display:none;" id="textContent" name="textContent"></textarea>    <!-- 第二个隐藏文本域,用来构造生成的HTML代码,方便表单POST提交,这里的name可以任意取,后台接受时以这个name键为准 -->    <textarea id="text" class="editormd-html-textarea" name="text"></textarea>  </div>

初始化编辑器

var testEditor;  $(function () {    testEditor = editormd("test-editormd", {      width: "90%",      height: 640,      syncScrolling: "single",      path: "${re.contextPath}/editor/lib/",      imageUpload: true,      imageFormats: ["jpg", "jpeg", "gif", "png", "bmp", "webp"],      imageUploadURL: "/file",      //这个配置在simple.html中并没有,但是为了能够提交表单,使用这个配置可以让构造出来的HTML代码直接在第二个隐藏的textarea域中,方便post提交表单。      saveHTMLToTextarea: true      // previewTheme : "dark"    });  });

这样就实现了最简单的editor.md编辑器,效果如下:

访问地址:http://localhost:8080/

图片上传

由于在初始化编辑器中配置的图片上传地址为imageUploadURL: "/file",,与之对应,我们在/file处理文件上传即可

@RestController@RequestMapping("/file")@Slf4jpublic class FileController {//  @Value("")//  String folder = System.getProperty("user.dir")+File.separator+"upload"+File.separator;  /**   * 在配置文件中配置的文件保存路径   */  @Value("${img.location}")  private String folder;  @PostMapping  public FileInfo upload(HttpServletRequest request, @RequestParam(value = "editormd-image-file", required = false) MultipartFile file) throws Exception {    log.info("【FileController】 fileName={},fileOrginNmae={},fileSize={}", file.getName(), file.getOriginalFilename(), file.getSize());    log.info(request.getContextPath());    String fileName = file.getOriginalFilename();    String suffix = fileName.substring(fileName.lastIndexOf(".") + 1);    String newFileName = new Date().getTime() + "." + suffix;    File localFile = new File(folder, newFileName);    file.transferTo(localFile);    log.info(localFile.getAbsolutePath());    return new FileInfo(1, "上传成功", request.getRequestURL().substring(0,request.getRequestURL().lastIndexOf("/"))+"/upload/"+newFileName);  }  @GetMapping("/{id}")  public void downLoad(@PathVariable String id, HttpServletRequest request, HttpServletResponse response) {    try (InputStream inputStream = new FileInputStream(new File(folder, id + ".txt"));       OutputStream outputStream = response.getOutputStream();) {      response.setContentType("application/x-download");      response.setHeader("Content-Disposition", "attachment;filename=test.txt");      IOUtils.copy(inputStream, outputStream);      outputStream.flush();    } catch (Exception e) {    }  }}

文件预览

表单POST提交时,editor.md将我们的markdown语法文档翻译成了HTML语言,并将html字符串提交给了我们的后台,后台将这些HTML字符串持久化到数据库中。具体在页面显示做法如下:

<!DOCTYPE html><html lang="zh"><head>  <meta charset="utf-8"/>  <title>Editor.md examples</title>  <link rel="stylesheet" href="${re.contextPath}/editor/css/editormd.preview.min.css" rel="external nofollow" />  <link rel="stylesheet" href="${re.contextPath}/editor/css/editormd.css" rel="external nofollow" rel="external nofollow" /></head><body><!-- 因为我们使用了dark主题,所以在容器div上加上dark的主题类,实现我们自定义的代码样式 --><div class="content editormd-preview-theme" id="content">${editor.content!''}</div><script src="${re.contextPath}/jquery.min.js"></script><script src="${re.contextPath}/editor/lib/marked.min.js"></script><script src="${re.contextPath}/editor/lib/prettify.min.js"></script><script src="${re.contextPath}/editor/editormd.min.js"></script><script type="text/javascript">  editormd.markdownToHTML("content");</script></body></html>

预览地址:http://localhost:8080/editorWeb/preview/{id}

编辑地址:http://localhost:8080/editorWeb/edit/{id}

代码下载

从我的 github 中下载,https://github.com/longfeizheng/editor-markdown

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持武林网。

发表评论 共有条评论
用户名: 密码:
验证码: 匿名发表