npm 包 highlightjs 使用教程

阅读时长 4 分钟读完

在前端开发中,代码语法高亮是非常重要的。高亮代码可以让阅读代码的人更加容易理解代码,提高代码的可读性和可维护性。highlightjs 是一个使用简单的代码语法高亮库,可以帮助我们轻松地实现代码高亮效果。

安装

在使用 highlightjs 前,我们需要先使用 npm 进行安装。在终端中输入以下命令即可完成安装:

示例

以下是一个简单的示例,使用 highlightjs 对代码进行高亮:

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

在上面的代码中,我们引入了 highlightjs 的 CSS 和 JS 文件,并在 <pre><code> 标签中写入我们需要高亮的代码。在页面加载完成后,使用 hljs.initHighlightingOnLoad() 进行初始化,即可高亮我们的代码。

高级用法

highlightjs 内置了很多语言的代码高亮规则,但默认情况下只会高亮 HTML、CSS、JavaScript 和 XML。如果我们需要高亮其他语言的代码,则需要手动引入对应的语言模块。

例如,如果我们需要高亮 PHP 代码,可以在 HTML 文件中手动引入对应的语言模块:

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

如果需要高亮更多的语言,可以通过引入对应的语言模块来实现。

此外,highlightjs 还提供了丰富的 API,可以帮助我们更好地控制代码高亮效果。具体的 API 使用可以参考官网文档。

总结

highlightjs 是一个使用简单、功能强大的代码语法高亮库。在我们的前端开发中,使用 highlightjs 可以帮助我们轻松地实现代码高亮效果,提高代码的可读性和可维护性。我们可以通过手动引入语言模块和使用 API 等方式,定制适合自己的高亮效果。

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