npm包mos-plugin-toc使用教程

在前端开发中，我们经常需要编写文档来记录项目的相关信息。为了使文档更加清晰易读，我们需要为其添加目录。而 mos-plugin-toc 就是一个能够自动生成 Markdown 格式目录的 npm 包，在此为大家介绍如何使用它。

安装mos-plugin-toc

我们可以通过以下命令来安装mos-plugin-toc：

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

配置mos-plugin-toc

mos-plugin-toc 支持多个配置项，可以根据自己的需求进行设置。以下是一些通用的配置项：

• maxDepth: 目录最大深度，默认为 3 级
• skipFirstH1: 是否跳过第一级标题，默认为 true
• skipText: 要跳过的标题内容的正则表达式
• listType: 目录列表类型，有 ul 和 ol 两种可选，默认为 ul
• slugify: 用于 slug 化标题的函数

配置mos-plugin-toc的方式有两种：

1. 在mos的配置文件（.mosrc.js或.mosrc.json）中添加配置项

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

2. 在 Markdown 文件中直接插入配置项

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

使用mos-plugin-toc

在需要生成目录的 Markdown 文档中，我们只需要在文件的任意位置插入以下标记：

--- ---
---

然后mos-plugin-toc就会自动生成一个目录列表，将所有标题及其级别列出。

下面是一个完整的示例，展示了mos-plugin-toc如何为Markdown文档生成目录：

- ----

--- ---
---

-- ---

--- ----

--- ----

-- ---

--- ----

---- -----

---- -----

--- ----

通过运行 mos 命令，mos-plugin-toc 就会自动将上述示例文件转换为以下 Markdown 格式：

- ----

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

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