npm 包 markdown-it-highlightjs-external 使用教程

HTML 是前端开发中不可避免的一部分,而 Markdown 是 HTML 的一种更加简洁、易读的语法。而 markdown-it 是一款 JavaScript 的解析器,可以方便地将 Markdown 转化成 HTML,但是默认情况下 markdown-it 并不支持代码高亮。为了解决这个问题,我们可以使用一款叫做 markdown-it-highlightjs-external 的 npm 包来实现代码高亮功能。

安装

首先,我们需要使用 npm 命令来安装 markdown-it-highlightjs-external:

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

使用

使用 markdown-it-highlightjs-external 很简单,我们只需要在代码中引入两个包,然后在 markdown-it 的解析器中添加一个插件即可。

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

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

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

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

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

以上代码将会输出:

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

现在,我们已经成功地在 Markdown 中使用了 highlight.js 代码高亮。

深入分析

让我们深入了解一下 markdown-it-highlightjs-external 的实现过程。我们将一步一步地分析代码来理解这个过程。

引入包

首先,我们需要引入 markdown-it 和 highlight.js 两个包。这两个包都是必须的,因为 markdown-it 提供了 Markdown 的解析器,而 highlight.js 则用来实现代码的高亮。

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

初始化 markdown-it 实例

接着,我们需要初始化 markdown-it 解析器的实例。

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

这一步非常简单,我们只需要直接调用 markdownIt 函数就可以了。

引入插件

现在,我们需要引入 markdown-it-highlightjs-external 插件。

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

使用插件

让我们来看看如何使用这个插件。使用插件非常简单,我们只需要在 markdown-it 实例上调用 use 方法,并且将 markdown-it-highlightjs-external 的实例以及一些选项作为参数传入。

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

示例代码

最后,让我们来看一看完整的代码示例。这个示例展示了如何将 Markdown 转化成 HTML 并使用 highlight.js 实现代码高亮。

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

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

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

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

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

结论

在本文中,我们探索了如何使用 markdown-it-highlightjs-external npm 包来实现代码高亮。这个包让我们能够方便地将 Markdown 转化成 HTML,并且使用 highlight.js 实现代码高亮。希望这篇文章能够帮助你更好地使用这个 npm 包来开发你的前端项目。

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


猜你喜欢

  • npm 包 markdown-it-images-preview 使用教程

    在 Web 开发中,Markdown 是一种用来编写文档的语言。它的主要好处就是简单易学,易于阅读。然而,Markdown 对图片展示的功能比较有限,如果想要预览图片,必须手动添加 HTML 代码。

    4 年前
  • npm 包 markdown-it-katex-external 使用教程

    Markdown 是一种轻量级的标记语言,可用于快速编写结构化的文档,并且使用广泛。而 markdown-it-katex-external 则是一款支持 LaTeX 数学公式渲染的 npm 包。

    4 年前
  • npm包merges-utils使用教程

    简介 npm包merges-utils是一款前端工具库,用于数组和对象合并。这个工具库通过提供一些默认的合并策略,来自动完成对象或数组的合并,解决了在开发过程中需要手动对对象或数组进行合并的问题,节约...

    4 年前
  • npm 包 postcss-nested-import 使用教程

    介绍 PostCSS 是一款基于 Node.js 的 CSS 编译工具,具有极强的定制能力和良好的扩展性。其中 postcss-nested-import 插件是用于让你在 CSS 文件中引入其他 C...

    4 年前
  • npm 包 @zhennann/mavon-editor 使用教程

    前言 在前端开发中,我们往往需要使用文本编辑器来实现对文本进行编辑、渲染等操作。然而,自己从头写一个文本编辑器是一项非常耗时耗力的工作,因此,现有的开源文本编辑器成为了我们的首选之一。

    4 年前
  • npm 包 egg-born-module-a-mavoneditor 使用教程

    介绍 egg-born-module-a-mavoneditor 是一个基于 mavonEditor 的 egg-born 模块,用于在 egg 中方便地使用 mavonEditor 进行 Markd...

    4 年前
  • npm 包 egg-born-module-a-progress 使用教程

    前言 在 Web 前端开发中,经常会用到一些由其他工程师开发好的插件或是框架。npm 是目前最大的 JavaScript 包管理器,提供了丰富的代码库和工具,方便了开发者进行开发和协作。

    4 年前
  • npm 包 egg-born-module-a-sequence 使用教程

    本文介绍的是 egg-born-module-a-sequence 这个 npm 包的使用教程,该包提供了一种便捷的实现序列号生成器的方法,常用于订单、兑换码等场景。

    4 年前
  • npm 包 egg-born-module-a-settings 使用教程

    在 Egg.js 框架开发中,egg-born-module-a-settings 是一个常用的 npm 包,它提供了一种方便的方式来管理 Egg.js 应用的模块配置。

    4 年前
  • npm 包 @zhennann/socketio 使用教程

    随着现代 Web 应用的不断发展和复杂化,实时通信已经成为了前端开发中不可或缺的一部分。而 Socket.IO 作为最流行的实时通信库之一,已经被广泛应用于各类 Web 应用开发中。

    4 年前
  • npm 包 egg-born-module-a-socketio 使用教程

    前言 近年来,随着互联网技术的不断发展,前端的技术也越来越多样化、复杂化。其中, Socket.io 技术的出现大大提高了前端应用的实时性,同时也带来了更多的挑战。

    4 年前
  • npm 包 egg-born-module-a-status 使用教程

    什么是 egg-born-module-a-status ? egg-born-module-a-status 是基于 Egg.js 框架开发的一个状态管理模块,可以帮助前端开发者快速在应用中使用状态...

    4 年前
  • npm 包 Egg Born Module A ThemeHyacinth 使用教程

    Egg Born Module A ThemeHyacinth 是一款高度定制化的 Egg.js 主题包,旨在为开发者提供极致的界面体验和扩展性。本教程将介绍该包的详细使用方法和注意事项,帮助开发者更...

    4 年前
  • npm 包 egg-born-module-a-validation 使用教程

    在开发 Web 应用程序时,数据验证是一个不可或缺的步骤。egg-born-module-a-validation 是一个方便易用的 npm 包,它能够帮助我们快速地完成数据验证工作。

    4 年前
  • NPM 包 @types/os-homedir 使用教程

    简介 在 Node.js 开发过程中,有许多常见的操作都需要读取操作系统的相关信息。其中,获取用户 Home 目录是比较常见的一种操作。Node.js 原生提供了 os.homedir() 方法来获取...

    4 年前
  • npm 包 @types/signal-exit 使用教程

    在前端开发中,可能会遇到需要监听主进程的退出事件的需求。这时候可以使用 npm 包 @types/signal-exit 来实现这个功能。 什么是 @types/signal-exit @types/...

    4 年前
  • npm包@c88/v8-coverage使用教程

    前言 在前端开发中,性能优化一直是一个重要的议题。而在性能优化的过程中,代码覆盖率是一个至关重要的指标,它可以帮助我们发现代码中的潜在问题,从而提高代码的质量。而今天我们将介绍一个针对代码覆盖率的np...

    4 年前
  • npm 包 @types/istanbul-lib-source-maps 使用教程

    在现代 Web 应用的开发中,前端代码的测试和调试已经变得越来越重要。而 Istanbul 是一个流行的前端代码覆盖率工具,它可以帮助开发者优化代码。在使用 Istanbul 进行测试时,我们也需要使...

    4 年前
  • npm 包@types/whatwg-mimetype 使用教程

    在前端开发过程中,我们会经常使用一些 npm 包来辅助我们完成工作。@types/whatwg-mimetype 就是其中一种有用的 npm 包,它提供了一些类型定义,可以帮助我们在开发过程中更好地使...

    4 年前
  • npm 包 @types/tail 使用教程

    在前端开发中,我们经常使用 JavaScript 库和框架来简化我们的工作。开发过程中,我们需要了解这些工具的使用方法和使用它们的内部机制,这样才能更好地利用它们来构建强大的 Web 应用程序。

    4 年前

相关推荐

    暂无文章