npm 包 ckeditor5-build-classic-markdown 使用教程

前言

在前端开发的日常工作中,常常需要使用富文本编辑器来编辑文章、动态等,以满足用户需求,提高用户体验。在富文本编辑器的众多选择中,CKEditor 是一款知名的富文本编辑器,它支持自定义配置、多语言等特性,广受开发者喜爱。

然而,在实际使用的过程中,开发者们也面临着各种挑战,如富文本编辑器的初始化、文本格式转换等问题。本文将介绍 npm 包 ckeditor5-build-classic-markdown 的用法,帮助开发者快速搭建使用 CKEditor5 进行富文本编辑的环境,并以 Markdown 格式保存数据,方便后续的文本处理。

环境准备

需要自行安装Node.js和npm,以及开发所需的IDE。

安装 CKEditor5-build-classic-markdown

在终端中输入以下命令:

--- ------- ------------------------------------------

引入 CKEditor5

在 HTML 文件中引入 CKEditor5:

--------- -----
------
------
   ----- ----------------
   ---------------- ------------
   ------- -------------------------------------------------------------------------------------------
   ---- ------- ---
   ----- ----------------------------------------------------------------------------------- ---------------- ----------------
-------
------
  ------------- ---------
  ---- ------------------
-------
-------

使用 CKEditor5 进行富文本编辑

为了让 CKEditor5 能够在页面中渲染,需要进行以下的配置,将编辑器所需的模块加载到编辑器中:

--------- ---------------------
----- ------------- - ----------------------------------
-------------
    ---------------------- -
       -------- - ------- --------- ------- --------------- --------------- ------------ --
       --------- --------
       ------------- -
         ---------- --  ---------
       --
       --------- -
         ---------- --  ---------
       -
    --
    ------------ -- -
       ----------------------- ---------------------------------- - --   -- -------
    --
    ------------ -- -
       -------------------- ------------ --- ---------- -- -------
    ---

通过 create 方法,在 editorElement 中创建一个富文本编辑器。toolbar 属性指定使用的工具条组件。language 属性指定语言。simpleUpload 属性和 ckfinder 属性指定上传文件的地址等信息。

我们需要添加以下代码,让编辑器所需的 CSS 样式和 JS 文件被加载。

-----------
----- ----------------------------------------------------------------------------------- ---------------- ----------------
------------------
----- --------------------------------------------------------------------------------------------- ---------------- ----------------

-------------------------------------
------- -------------------------------------------------------------------------------------------
--------------
------- -------------------------------------------------------------------
--------------
------- ----------------------------------------------------------------------------------
---------
------- ---------------------------------------------------------------------------
---------
------- -----------------------------------------------------------------------------
----------
------- ------------------------------------------------------------------------------------
----------
------- --------------------------------------------------------------------------------
---------
------- -------------------------------------------------------------------
-----------
------- -------------------------------------------------------------------
---------
------- --------------------------------------------------------------------------------
-----------
------- ---------------------------------------------------------------------------------------------
-----------
------- -----------------------------------------------------------------------
-----------
------- ---------------------------------------------------------------------
------------
------- --------------------------------------------------------------------------------
-----------
------- ------------------------------------------------------------------------------
------------
------- ----------------------------------------------------------------------------------------

Markdown 保存

在文本编辑器中,我们并不想使用过多的带格式字符串或者 html 标签来保存数据,因为这样不利于数据的处理。我们希望能够使用常见的 Markdown 格式来保存数据,并将其转换为 html 格式以供后续阅读。市面上已有相关的开源库,如 turndown,但是使用起来相对麻烦,需要引入较多的依赖,增加了项目的复杂度。

CKEditor5 提供了一个 plugin,叫作 markdown,它能够将编辑器中的富文本内容转化为 Markdown 格式的字符串。我们可以将该字符串与后端交互,并保存起来。在页面展示时,我们可以根据需要将该 Markdown 字符串转化为 HTML 格式的内容展示。使用方法如下:

---------------------------

上述方法将返回以 Markdown 格式表示的文章内容。需要引入 @ckeditor/ckeditor5-markdown-gfm 包,使用如下:

------ -------- ---- ------------------------------------------------

-------------
  -------- -------------- -
    -- -
    -------- - --------- - --
  - -
  ------ - -
  ------- - --

Ckeditor5-build-classic-markdown 中包括所需的所有内容,则使用时无需单独安装。

小结

使用 CKEditor5 进行富文本编辑涉及到的细节非常多,需要注意配置、依赖等问题。本文介绍了 CKEditor5 的 npm 包 ckeditor5-build-classic-markdown 的基本用法,使得开发者可以快速搭建一个基于 Markdown 格式保存的富文本编辑器环境。希望本文能够对前端开发者在中使用 CKEditor5 进行日常开发提供一些帮助。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/6005663c81e8991b448e2400


猜你喜欢

  • nvs-serailzer

    Yet another serializer for typescript Thanks to Hagai Cohen (aka DxCx) for boilerplate! HomePage htt...

    3 年前
  • npm 包 react-native-bluemix 使用教程

    npm 包 react-native-bluemix 使用教程 React Native 是当前最热门的移动应用开发技术之一,而蓝云 Bluemix 则是 IBM 在云计算领域推出的一款云服务平台。

    3 年前
  • NPM 包: the-fetch-you-were-looking-for 使用教程

    在 Web 开发中,fetch API 是一种用于获取资源的方法。但其使用起来有时不太方便,需要对返回的响应进行解析和异常处理等。为了解决这些问题,the-fetch-you-were-looking...

    3 年前
  • npm包webpack-php-output的使用教程

    在前端开发中,如何将webpack打包的静态资源输出到PHP项目中?这就是npm包webpack-php-output的作用。本文将详细介绍如何使用这个npm包,以及它的深度和学习以及指导意义,包含示...

    3 年前
  • npm 包 hjs-collection 使用教程

    介绍 hjs-collection 是一款基于 JavaScript 的 npm 包,它提供了丰富的数据结构和算法实现。使用 hjs-collection 可以帮助我们轻松地处理常见的数据结构和算法问...

    3 年前
  • npm 包 hosts-edit 使用教程

    简介 在开发前端项目时,我们通常需要在 hosts 文件中添加一些域名映射以模拟线上环境。而手动修改 hosts 文件往往比较繁琐,特别是当 hosts 文件中已经有很多配置时。

    3 年前
  • npm 包 @typescript-standard-library/core 使用教程

    在前端开发中,使用规范的代码库特别重要。@typescript-standard-library/core 就是一个这样的 npm 包,它提供了 TypeScript 的标准库,使项目能够更加规范和易...

    3 年前
  • NPM包pubg-stats使用教程

    简介 在前端开发中,我们经常需要使用各种NPM包来帮助我们快速开发,提高开发效率。而今天,我们将介绍一个名为pubg-stats的NPM包。该包可以帮助我们查询玩家在游戏《绝地求生》中的数据,如击杀数...

    3 年前
  • npm 包 kitsu.js 使用教程

    Kitsu.js 是一个用于处理 HTTP 请求的 JavaScript 库,它的设计旨在简化前端开发中与服务器交互的过程。在本文中,我们将介绍如何使用 npm 包 kitsu.js 来处理 HTTP...

    3 年前
  • npm 包 btdb-search 使用教程

    btdb-search 是一个 npm 包,可以用于在 BitTorrent 网络上搜索资源。在前端项目中使用它非常便捷,因为它提供了一个简单的 API 接口,可以轻松地使用它进行搜索。

    3 年前
  • npm 包 @hawkrives/react-native-alphabetlistview 使用教程

    前言 前端开发是一个发展迅速的行业,新技术不断涌现。在这些新技术中,npm 包(Node.js 包管理器)应用最为广泛。npm 包为前端开发带来了诸多便利和进步,其中 @hawkrives/react...

    3 年前
  • npm 包 node-fuzzy-alexbv 使用教程

    在前端开发中,有很多常见的需求需要对数据进行模糊匹配和搜索,比如搜索过滤器、自动补全功能等。而 npm 包 node-fuzzy-alexbv 就是一款用于实现模糊匹配和搜索的工具。

    3 年前
  • npm 包 pyro.js 使用教程

    Pyro.js 是一款强大的前端工具,在前端开发过程中可以大幅提高开发效率。本文将为您详细介绍 npm 包 pyro.js 的使用教程,并附带示例代码,希望对您在前端开发中有所帮助。

    3 年前
  • 使用 @hawkrives/react-native-sortable-list 的教程

    在 React Native 的开发中,列表组件是必不可少的,而一个好的列表组件不仅能够展示数据,还能够让用户自主排序。而 @hawkrives/react-native-sortable-list ...

    3 年前
  • npm 包 hicsail-hapi-mongo-models 使用教程

    hicsail-hapi-mongo-models 是一个封装了 MongoDB 数据库操作的 npm 包,为开发者提供了更便捷的方式来处理数据库操作。它提供了一些针对 MongoDB 数据库的 AP...

    3 年前
  • npm 包 react-native-aes-encryption-fix 使用教程

    前言 在现代化的移动应用中,数据加密是一个重要的问题。React Native 是目前流行的 JavaScript 框架之一,它提供了很多工具来解决这个问题。其中,react-native-aes-e...

    3 年前
  • 使用 ng4-adal 实现前端应用程序的认证授权

    介绍 ng4-adal 是一种对 Azure Active Directory (AAD) 认证与授权库的包装器。它可用于创建基于 Angular 4 的前端应用程序,以便使用 AAD 进行认证和授权...

    3 年前
  • npm 包 angularfire2-offline-v5 使用教程

    在前端开发中,我们经常需要使用一些开源的技术工具来帮助我们更快更便捷的开发应用程序。其中,npm 是目前最常用的包管理工具之一。而 angularfire2-offline-v5 是一个基于 fire...

    3 年前
  • npm 包 Asapp 使用教程

    在前端开发领域中,使用第三方库和工具是非常常见的。而 npm 包 Asapp 就是其中之一,它是一个用于创建和渲染应用状态组件的 JavaScript 库,具有强大的数据流控制和性能优化能力。

    3 年前
  • npm 包 vueable 使用教程

    什么是 vueable vueable 是一个基于 Vue.js 的表格组件,它支持分页、排序、筛选和自定义渲染等功能。同时,vueable 还提供了丰富的 API,方便开发者进行二次开发。

    3 年前

相关推荐

    暂无文章