npm 包 @ckeditor/ckeditor5-highlight 使用教程

阅读时长 7 分钟读完

前言

在前端开发中,富文本编辑器是一个非常重要的组件。而 CKEditor 是一个非常出色的富文本编辑器,在使用过程中,我们也可能需要对一些代码块进行语法高亮展示,这时候就需要使用到 CKEditor5 的 highlight 插件。本文将详细介绍该插件的使用方法。

安装

使用 highlight 插件,我们需要首先安装 @ckeditor/ckeditor5-highlight 包。可以通过 npm 下载该包,具体命令如下:

集成

在使用 CKEditor 时,我们需要引入 highlight 插件。可以通过以下方式:

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

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

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

pluginstoolbar 中都需要添加 Highlight

配置

我们可以通过在 CKEditor Config 中设置 Highlight 的形式,常用的格式有两种。一种是使用 CSS 样式:

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

另一种是使用 Prism.js:

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

不同的设置方法有不同的优缺点。使用 CSS 样式,我们可以直接设置样式,但是对于非代码部分,我们需要在代码中添加 <pre> 标签来包含它们。使用 Prism.js,我们可以直接在代码中插入样式,但是需要手动引入需要的语言模块。

示例

以下是使用 Prism.js 实现的示例代码:

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

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

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

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

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

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

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

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

在引入了 Highlight 插件和 Prism.js 后,我们就可以在页面中使用了。

使用 CKEditor 输出的代码将自动被 Prism 处理并生成高亮样式。

结语

以上是 @ckeditor/ckeditor5-highlight 包的使用教程。该插件简单易用,并且支持丰富的配置方式。使用它,我们可以方便地为页面中的代码块添加高亮样式,提升页面的可读性。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/5f3209b43b0ab45f74a8bd48

纠错
反馈