npm 包 headerblock 使用教程

什么是 headerblock？

headerblock 是一个基于 Node.js 环境的 npm 包，可以帮助我们在生成 Markdown 文档时更方便地添加标题块（headerblock）。

headerblock 主要包含以下特性：

可以通过传入标题的级别和文字内容，生成对应的标题块。
可以添加“展开”和“收起”功能，使文档更加简洁易读。
可以自定义标题块的样式和内容。

如何安装 headerblock？

使用 headerblock 很简单，只需要在终端中运行以下命令：

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

安装成功后，即可在项目中引入 headerblock。

如何使用 headerblock？

headerblock 提供了以下方法供我们使用：

headerBlock(level, content, expandable, summary)

其中，level 表示标题的级别，一般为 1-6，content 为标题的文字内容，在 Markdown 文档中则会显示为对应级别的标题。

expandable 和 summary 表示是否为可展开、可收起的标题块，展开按钮的文字内容分别为”展开“和”收起“。

我们可以使用以下示例代码来演示如何在 Markdown 文档中使用 headerblock：

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

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

在运行后，我们会得到以下效果：

点击展开