当我们需要在 markdown 文档中添加列表时，我们可以使用 npm 包 markdown-list。这个包可以让我们通过编写 markdown 格式的文本来生成各种格式的列表，包括数字列表、符号列表、复选框列表、表格等等。在本文中，我们将详细讲解 markdown-list 的使用方法。
安装 markdown-list
在使用 markdown-list 之前，我们需要先安装它。在终端中输入以下命令：
npm install markdown-list --save-dev
安装完成后，我们可以在项目中引入它：
const markdownList = require('markdown-list');数字列表
数字列表是有序的列表，每个列表项前面有一个数字。使用 markdown-list 可以轻松地生成数字列表。以下是一个示例：
-- -------------------- ---- ------- --- ------ - -------------- ------ ------ ------ -- - -------- ----- --- --------------------
输出结果：
1. 第一项 2. 第二项 3. 第三项
我们在使用 markdownList 函数时，把一个数组传递进去，数组中的每个元素都是一个列表项。通过设置 ordered: true，我们告诉 markdownList 函数生成有序列表。
符号列表
符号列表是无序的列表，每个列表项前面有一个符号。我们可以使用 markdown-list 生成符号列表。以下是一个示例：
let mdText = markdownList([ '第一项', '第二项', '第三项', ]); console.log(mdText);
输出结果：
- 第一项 - 第二项 - 第三项
在上面的示例中，我们没有传递第二个参数给 markdownList 函数，因此默认生成的是无序列表。
复选框列表
有时候我们需要在列表中添加复选框，以方便用户选择。markdown-list 支持生成复选框列表。以下是一个示例：
-- -------------------- ---- -------
--- ------ - --------------
-
----- ------
-------- -----
--
-
----- ------
-------- ------
--
-
----- ------
-------- ------
--
-- -
--------- -----
---
--------------------输出结果：
- [x] 第一项 - [ ] 第二项 - [ ] 第三项
在上面的示例中，我们把每个列表项都包裹在一个对象中，并通过 checkbox: true 告诉 markdownList 函数生成复选框列表。复选框列表中，每个列表项前面有一个复选框，可以通过 checked 属性设置是否勾选。
表格
除了列表，markdown-list 还可以生成表格。以下是一个示例：
-- -------------------- ---- ------- --- ------ - -------------- ------ ----- ------ ------- ----- ---- ------- --------- ----- ---------- -- - ------ ----- --- --------------------
输出结果：
|姓名|年龄|城市| |---|---|---| |Tom|25|New York| |Jerry|23|London|
在上面的示例中，我们把表格的数据放在一个二维数组中，并通过 table: true 告诉 markdownList 函数生成表格。
深入学习
使用 markdown-list 可以让我们更方便地在 markdown 中添加列表和表格，可以提高文档的阅读和使用体验。如果想要深入学习 markdown-list 的使用，可以查看它的官方文档 markdown-list - npm，里面有更详细的使用说明和示例代码。
结语
本文介绍了 markdown-list 的使用方法，包括数字列表、符号列表、复选框列表和表格。通过学习本文，我们可以更加方便地在 markdown 中添加各种列表和表格。希望本文对读者有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600559a381e8991b448d7362