在前端开发中，将HTML格式的内容转为Markdown格式是一项常见需求。npm上有许多markdown工具可以帮助我们完成这项任务，其中一个很流行的工具是to-markdown。
安装
要安装to-markdown，只需要在终端中运行以下命令：
--- ------- ----------- ------
使用
to-markdown提供了非常简单的API并且易于使用。假设我们有一个HTML字符串htmlString需要转成Markdown，只需要像下面这样调用toMarkdown()函数即可：
----- ---------- - ----------------------- ----- -------------- - -----------------------
如果需要将HTML元素转成特定的Markdown元素，可以传递第二个参数作为选项。例如，如果想要将所有<h1>标签转成Markdown的#语法，可以使用以下选项：
----- ------- - -
----------- -
-
------- -----
------------ --------- -- -- -----------
-
-
--
----- -------------- - ---------------------- ---------选项
to-markdown的选项可以通过一个对象传递给toMarkdown()函数。以下是可用选项的列表：
gfm: （默认值：true）是否启用Github Flavored Markdown。converters: 要使用的转换器列表。每个转换器都是一个对象，必须具有filter和replacement属性。filter指定要转换的HTML标签名，replacement是一个函数，它接受一些参数（如内容、属性等）并返回Markdown字符串。allowTbody: （默认值：true）是否允许将<tbody>标签包裹在<table>标签外部。
转换器
to-markdown自带了许多内置转换器，但也可以定义自己的转换器。以下是一些内置的转换器：
converters.a: 将<a>标签转为Markdown格式的链接。converters.code: 将<code>标签转为Markdown格式的行内代码。converters.blockquote: 将<blockquote>标签转为Markdown格式的引用。converters.h1-converters.h6: 将<h1>到<h6>标签分别转为Markdown格式的标题。converters.hr: 将<hr>标签转为Markdown格式的分割线。converters.img: 将<img>标签转为Markdown格式的图片。converters.li: 将<li>标签转为Markdown格式的列表项。converters.ol: 将<ol>标签转为Markdown格式的有序列表。converters.ul: 将<ul>标签转为Markdown格式的无序列表。converters.table: 将<table>标签转为Markdown格式的表格。
示例
下面是一个完整的示例，它将HTML字符串转换为Markdown格式：
----- ---------- - -----------------------
----- ---------- - -
---------- -----------
------- -- - --------------
----
-------- ------
-------- ------
-----
--
----- ------- - -
----------- -
-
------- -----
------------ --------- -- -- -----------
-
-
--
----- -------------- - ---------------------- ---------
----------------------------输出结果应该如下所示：
- ------ ------ ---- -- - ---------- - ---- - - ---- -
总结
to-markdown是一个非常实用的npm包，可以帮助我们快速将HTML格式的内容转为Markdown格式。通过本文的介绍，您已经了解到了如何安装和
来源：JavaScript中文网 ，转载请注明来源 本文地址：https://www.javascriptcn.com/post/33882