npm 包 markdown-highlight-html 使用教程

在前端开发中,Markdown 是一种常用的文本格式,而且模板语法简单,所以在编辑 README 文件或个人博客的时候也比较普遍,但是 Markdown 中无法直接对代码进行高亮处理,这时候就需要借助一个 npm 包——markdown-highlight-html。

在本文中,我们将会介绍如何在前端应用中使用 markdown-highlight-html 包,以及如何在你的 Markdown 文章中使用代码高亮。

markdown-highlight-html 详解

markdown-highlight-html 支持多种语言的代码高亮,同时还支持自定义样式。

  • 语言支持:

    • javascript
    • css
    • html
    • python
    • ruby
    • C#
    • bash
    • sql
    • markdown
  • 样式

    • 默认样式:github
    • 支持自定义

使用教程

我们将使用 webpack 构建一个简单的前端项目并引入 markdown-highlight-html 包。首先,我们需要在项目中安装 markdown-highlight-html 包。在终端输入以下命令:

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

安装完成后,我们需要在 webpack 中配置规则,以便让 webpack 能够识别和解析 markdown 文件,同时还要对代码片段进行高亮处理。

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

我们需要通过 webpack 的 loader 规则来将 markdown 文件转化成 html 格式,并且高亮显示其中的代码片段。其中,markdown-highlight-html-loader 用于将 markdown 文件转换为包含代码高亮的 html 文件,我们需要在 webpack 中安装此 loader:

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

在以上配置中,除了 test 属性用于匹配 .md 文件外,还可以配置多种自定义参数,用于指定生成的 html 标签和样式名等等。具体语法可以在 markdown-highlight-html-loader 官网中查看。

Markdown 整合代码高亮

现在我们已经成功引入了 markdown-highlight-html 包并在 webpack 中配置了相关规则,下面我们将介绍如何在 markdown 文章中使用代码高亮。

我们以 javascript 代码块的高亮为例。使用 markdown 原生语法以及高亮标记,如下所示:

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

经过以上语法转换后,我们得到一个由 markdown-highlight-html 自动生成的 html 网页,并且代码片段已经被高亮处理:

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

最后在放入你的 web 页面中即可。

总结

markdown-highlight-html 提供了非常简单优美的解决方案,能够让我们轻松地在 markdown 中使用代码高亮。同时,它还提供多种语言的代码高亮,并支持自定义样式。

希望这篇文章能够对你有所指导,如果你在使用 markdown-highlight-html 过程中遇到问题,也欢迎来尝试本文提供的解决方案。

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


猜你喜欢

  • npm 包 html2plaintext-2 使用教程

    在前端开发中,我们经常需要将 HTML 文本转换为纯文本,比如在搜索引擎优化、爬虫抓取等方面。而 npm 包 html2plaintext-2 可以很好地完成这个任务。

    2 年前
  • npm 包 dt-easy-pie-chart 使用教程

    简介 dt-easy-pie-chart 是一款基于 jQuery 和 CSS3 的简单环形图数据可视化工具,可以帮助你快速生成漂亮的环形图,并且支持响应式布局。该工具已经发布到 npm 上,并且可以...

    2 年前
  • npm 包 Storybook-adk 使用教程

    #npm 包 Storybook-adk 使用教程 ##简介 Storybook-adk 是一个基于 React 的 UI 元素库,在前端开发中扮演着重要角色。它为开发人员提供了模拟组件编写的功能,允...

    2 年前
  • npm 包 xbox-controller-360 使用教程

    简介 xbox-controller-360 是一个可在 Node.js 项目中使用的 npm 模块,用于接收 Xbox 360 手柄的输入数据。在前端开发中,玩家使用游戏手柄的情况越来越常见,而该模...

    2 年前
  • 前端技术文章:npm 包 @web-atrio/tabs-responsive 使用教程

    在前端开发中,我们经常会用到样式类似于选项卡的组件,而 @web-atrio/tabs-responsive 就是一个非常不错的 npm 包,可以帮助我们快速地实现这样的组件。

    2 年前
  • npm 包 json-to-pivot-json 使用教程

    在前端开发中,我们常常需要对数据进行整理和处理。而 json-to-pivot-json 是一个很好用的npm包,它可以将一个json数据集合转化成一个带有合计行和合计列的新json数据集合。

    2 年前
  • npm 包 my-ng2-cli-tools 使用教程

    概述 my-ng2-cli-tools 是一个基于 Angular 2 的 npm 包,可以帮助前端开发者快速生成模块和组件代码,并提供了一些实用的工具函数和组件。

    2 年前
  • npm 包 likin_acl 使用教程

    在前端开发中,许多项目都需要权限控制,这时候使用一些现成的 npm 包可以大大加快开发速度。本文介绍一个适用于 Node.js 的权限控制 npm 包 likin_acl 的使用教程。

    2 年前
  • npm 包 ewindisch-test-package 使用教程

    简介 npm 是 Node.js 的包管理工具,我们可以通过 npm 安装、管理和发布 node.js 模块和命令行工具。 ewindisch-test-package 是一个示例 npm 包,它主要...

    2 年前
  • npm 包 char 使用教程

    如果你是一名前端开发者,那么你一定会用到字符串操作。而 char 是一个非常强大的 npm 包,它可以帮助你轻松地进行字符串操作。本文将介绍 char 的使用教程,并提供一些示例代码帮助你更好地学习和...

    2 年前
  • npm 包 node-distributed-timer 使用教程

    前言 在前端开发中,我们经常会使用计时器来处理各种任务。而在分布式环境下,不同机器的系统时间可能不同,使用计时器就会遇到问题。这时候,我们需要使用 node-distributed-timer 这个 ...

    2 年前
  • npm 包 gulp-jsonlint-2 使用教程

    npm(Node Package Manager)是 Node.js 的包管理器,在开发中,我们可以使用它来下载各种库和工具来帮助我们提高效率,其中包括了一个名为 gulp-jsonlint-2 的包...

    2 年前
  • npm 包 peer-compatible 使用教程

    简介 在前端开发当中,我们经常需要使用第三方 npm 包来辅助我们的工作。其中有一类 npm 包被称为 peer-dependency,它们通常作为另一个 npm 包的依赖,而不是直接在项目中使用。

    2 年前
  • npm 包 ng-charts 使用教程

    ng-charts 是一个基于 Chart.js 封装的 AngularJS 图表库,可以在 AngularJS 应用程序中方便地绘制出各种图表。其特点是易于使用、配置灵活、支持多种图表类型等,是一个...

    2 年前
  • npm 包 nuxt-cli 使用教程

    在现代的前端开发中,使用框架来完成开发任务已经成为了趋势。Nuxt.js 是一个基于 Vue.js 的服务端渲染框架,能够帮助开发者快速地构建出高质量的 Vue.js 应用程序。

    2 年前
  • npm 包 proxy-middleware-2 使用教程

    在前端开发中,我们经常需要通过代理服务器来处理跨域请求等问题。npm 包 proxy-middleware-2 可以帮助我们快速地搭建一个代理服务器。本文将为大家详细介绍 proxy-middlewa...

    2 年前
  • npm包wox-admin-nav使用教程

    在前端开发中,wox-admin-nav是一款非常实用的导航菜单组件,它能够帮助我们快速地搭建出一个美观实用的后台管理系统的导航菜单。本文将为大家介绍wox-admin-nav的使用方法,帮助大家更好...

    2 年前
  • npm 包 @jonny/draft-convert 使用教程

    引言 在现代的 Web 开发中,前端框架和工具日新月异,对于开发者而言,需要不断学习和掌握新的技术和工具。而 npm 是目前广泛使用的前端包管理器,它提供了大量的开源和组件化的代码库,可以加速开发过程...

    2 年前
  • npm 包 snabbdom-to-amp 使用教程

    简介 本文将介绍 npm 包 snabbdom-to-amp 的使用方式和注意事项。snabbdom-to-amp 的作用是将 Snabbdom 虚拟 DOM 转换成 AMP 页面中的有效 HTML ...

    2 年前
  • npm 包 @jonny/draft-js-single-line-plugin 使用教程

    在前端开发过程中,实现单行文本编辑器是一个常见的需求。而 @jonny/draft-js-single-line-plugin 就是一个帮助我们快速实现单行文本编辑的 npm 包。

    2 年前

相关推荐

    暂无文章