FastGPT icon indicating copy to clipboard operation
FastGPT copied to clipboard

建议给知识库编辑集成一个简易的markdown编辑器,这样经常修改和调整方便一些

Open sunk926 opened this issue 1 year ago • 0 comments

例行检查

'方框内填 x 表示打钩'

  • [x] 我理解并认可上述内容,并理解项目维护者精力有限,不遵循规则的 features 可能会被无视或直接关闭

相关示例 有很多简易且易于集成的 Markdown 编辑器可以通过 HTML、JS 和 CSS 实现,以下是几款常用的:

1. SimpleMDE

  • 特点: SimpleMDE 是一个非常流行的 Markdown 编辑器,具有友好的用户界面,并且易于集成到网页中。

  • 集成方式: 只需要引入 CSS 和 JS 文件,并通过简单的 HTML 初始化即可。

  • 官网: [SimpleMDE GitHub](https://github.com/sparksuite/simplemde-markdown-editor)

  • 代码示例:

    <link rel="stylesheet" href="https://cdn.jsdelivr.net/simplemde/latest/simplemde.min.css">
    <script src="https://cdn.jsdelivr.net/simplemde/latest/simplemde.min.js"></script>
    
    <textarea id="markdown-editor"></textarea>
    
    <script>
      var simplemde = new SimpleMDE({ element: document.getElementById("markdown-editor") });
    </script>
    

2. Editor.md

  • 特点: 功能丰富,支持代码高亮、预览、同步滚动等功能,且非常易于定制。

  • 集成方式: 通过引入官方提供的 CSS 和 JS 文件,并在 HTML 中初始化编辑器。

  • 官网: [Editor.md 官方网站]()

  • 代码示例:

    <link rel="stylesheet" href="https://pandao.github.io/editor.md/css/editormd.css">
    <script src="https://pandao.github.io/editor.md/editormd.js"></script>
    
    <div id="editor"></div>
    
    <script>
      $(function() {
          editormd("editor", {
              path : "https://pandao.github.io/editor.md/lib/"
          });
      });
    </script>
    

3. MarkDown-it

  • 特点: 轻量且高效的 Markdown 解析器,专注于解析而不是编辑,适合嵌入复杂的自定义 UI。

  • 集成方式: 通过引入 markdown-it.js 文件进行解析,然后通过自定义前端界面。

  • 官网: [MarkDown-it GitHub](https://github.com/markdown-it/markdown-it)

  • 代码示例:

    <script src="https://cdn.jsdelivr.net/npm/markdown-it/dist/markdown-it.min.js"></script>
    
    <textarea id="input"></textarea>
    <div id="output"></div>
    
    <script>
      var md = window.markdownit();
      var result = md.render('# markdown content');
      document.getElementById("output").innerHTML = result;
    </script>
    

4. Showdown

  • 特点: 一个纯 JS 的 Markdown 到 HTML 转换器,非常轻量化,容易集成。

  • 集成方式: 通过加载 showdown.js,调用 API 将 Markdown 转换为 HTML。

  • 官网: [Showdown GitHub](https://github.com/showdownjs/showdown)

  • 代码示例:

    <script src="https://cdn.jsdelivr.net/npm/showdown/dist/showdown.min.js"></script>
    
    <textarea id="markdown"></textarea>
    <div id="html"></div>
    
    <script>
      var converter = new showdown.Converter();
      var markdown = document.getElementById("markdown").value;
      var html = converter.makeHtml(markdown);
      document.getElementById("html").innerHTML = html;
    </script>
    

选择建议:

  • 如果你需要一个开箱即用、带 UI 的解决方案,SimpleMDEEditor.md 是不错的选择。
  • 如果你需要高度定制化或仅仅是解析 Markdown,MarkDown-itShowdown 会更轻量且灵活。

你可以根据项目需求选择合适的 Markdown 编辑器。

sunk926 avatar Sep 22 '24 05:09 sunk926