npm 包 toc 使用教程

阅读时长 2 分钟读完

当我们在编写一篇较长的 Markdown 文章时,为了方便读者阅读和快速定位内容,我们通常会添加目录。手动书写目录虽然简单,但是当文章变得复杂时,手动维护目录就比较繁琐了。这时候可以使用 npm 包 toc 来自动生成目录。

安装

在终端中输入以下命令进行安装:

使用方法

  1. 在 Markdown 文件中添加特殊注释[toc]作为目录的位置标记。

    -- -------------------- ---- -------
    -----
    
    - ---
    --
    -- ----
    --
    -- ----
    --
    - ---
    --
  2. 在终端中进入 Markdown 文件所在的目录,并执行以下命令:

    执行完毕后,目录将会自动生成在 Markdown 文件的 [toc] 注释下方。

额外选项

  • -i--in-place: 以原文件替换生成的目录。
  • -s--max-depth: 指定目录的最大深度,默认值为 6。

示例代码

下面是一个示例 Markdown 文章,演示了如何使用 toc 自动生成目录。

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

- --

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

- --

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

$ npm install -g toc

[toc]

标题一

正文

子标题一

正文

子标题二

正文

标题二

正文

$ toc 文件名.md

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

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

- ----

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

- --

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

总之,如果你经常编写较长的 Markdown 文章,那么使用 toc 将会是一个非常实用的工具。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/36448

纠错
反馈