Contribute to this guide

guide粘贴 Markdown

粘贴 Markdown 功能允许用户将 Markdown 格式的内容直接粘贴到编辑器中。然后,它将被实时转换为富文本。

此功能仍处于实验阶段。请参阅已知问题部分了解更多信息。

# 演示

将一些 Markdown 格式的内容粘贴到下面的演示编辑器中,然后实时查看它转换为富文本。为了方便,您可以复制这份文档

输出

此演示展示了一组有限的功能。请访问功能丰富的编辑器示例以查看更多实际操作。

# 安装

⚠️ 新的导入路径

42.0.0 版本开始,我们更改了导入路径的格式。本指南使用新的、更短的格式。如果您使用的是旧版本的 CKEditor 5,请参考旧版设置中的包指南。

安装编辑器后,将此功能添加到插件列表和工具栏配置中

import { ClassicEditor, Bold, Italic, Essentials, PasteFromMarkdownExperimental } from 'ckeditor5';
// More imports.
// ...

ClassicEditor
    .create( document.querySelector( '#snippet-markdown' ), {
        plugins: [
            PasteFromMarkdownExperimental,
            Essentials,
            Bold,
            Italic,
            // More plugins.
            // ...
        ],
        // More of editor's configuration.
        // ...
    } )
    .then( /* ... */ )
    .catch( /* ... */ );

# 已知问题

虽然粘贴 Markdown 功能已经足够稳定可以使用,但它仍然需要更多测试。我们现在专注于测试它与其他工具和插件的连接。如果您有任何观察、建议或反馈要分享,请随时将其发布到这个 GitHub 问题中。

CKEditor 5 支持更广泛的粘贴功能,包括

  • 从 Office 粘贴 – 从 Microsoft Word 粘贴内容,并保留原始结构和格式。
  • 从 Google Docs 粘贴 – 从 Google Docs 粘贴内容,保留原始格式和结构。
  • 粘贴纯文本 – 粘贴不带格式的文本,它将继承其被粘贴到的内容的样式。
  • 自动格式化 – 使用类似 Markdown 的简码,在您输入时格式化您的内容。

# 贡献

此功能的源代码可在 GitHub 上获得,地址为https://github.com/ckeditor/ckeditor5/tree/master/packages/ckeditor5-markdown-gfm