在前端开发过程中，我们经常需要将 HTML 文档转换为 Markdown 格式，用于展示、分享或者其他用途。而 npm 包 html-md-2 就是一款非常优秀的 HTML 转 Markdown 工具。本文将为大家详细介绍如何使用 html-md-2 进行 HTML 转 Markdown。
安装
使用 npm 安装 html-md-2：
npm install html-md-2
安装成功后，我们就可以在项目中使用 html-md-2 进行 HTML 转 Markdown。
API
html-md-2 暴露了一个函数，可用于将 HTML 转换为 Markdown。
htmlmd2(html, options)
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| html | string | 是 | 待转换的 HTML 字符串 |
| options | object | 否 | 配置项，具体请见下文 |
options 配置项
| 参数 | 类型 | 默 认 | 描述 |
|---|---|---|---|
| headerOffset | number | 0 | 标题级别偏移量，即在 HTML 中使用的是 h1，而在输出的 Markdown 文件中却是 h2，这个偏移量就是 1。 |
| gfm | boolean | false | 是否启用 GitHub Flavored Markdown，开启后会自动将行末的 \n 转成 \n\n，以满足 GFM 规范。 |
| converter | object | {} | 自定义转换器，可用于对 HTML 中的标签或者文本进行转换，具体请见下文。 |
converter 自定义转换器
若要对 HTML 中的标签或者文本进行转换，需要传入 converter 对象。该对象包含以下两个属性：
tags
一个 Hash 对象，用于定义标签的转换方式，键为标签名，值为转换函数。例如：
-- -------------------- ---- ------- ----- --------- - - ----- - -- -------- ------ ----- --------------- - ------ -------------------- -------- -- ---- -------- ------ ----- - ------ -------------------------------------- -- --- -------- ------ ----- --------------- - ------ -------------------- --------------------- - - --展开代码
text
一个用于对文本进行处理的回调函数，例如：
const converter = { text: function (text) { return text.replace(/foo/g, 'bar'); } };
示例
最后，我们来看一个简单的示例。假设我们有以下 HTML：
-- -------------------- ---- ------- --------- ----- ------ ------ ----- ---------------- ----------- -- - ------------ ------- ------ --------- ---------- ------- -- - -------------------------- ---- -------- ------ -------- ------ ----- ------- -------展开代码
以下是如何使用 html-md-2 进行转换：
-- -------------------- ---- ------- ----- ------- - --------------------- ----- ---- - - --------- ----- ------ ------ ----- ---------------- ----------- -- - ------------ ------- ------ --------- ---------- ------- -- - -------------------------- ---- -------- ------ -------- ------ ----- ------- ------- -- ----- -------- - -------------- ----------------------展开代码
输出如下：
# Hello World This is a **test**. - Item 1 - Item 2
总结
以上就是使用 html-md-2 进行 HTML 转 Markdown 的方法。通过本文的介绍，我们了解了 html-md-2 的基本用法与 API，以及如何自定义转换器来满足我们的需求。希望读者可以通过本文学会如何使用 html-md-2，并掌握其更多高级功能，让 HTML 转 Markdown 变得更加便利。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5eedb9e2b5cbfe1ea06118c0
