在前端开发中，我们常常需要将 Markdown 文件转换为 HTML 页面。Metalsmith-md-summary 是一个方便的 NPM 包，可以实现将 Markdown 文件转换为 HTML 并生成目录摘要。本文将介绍如何使用该包及其核心功能。
安装
Metalsmith-md-summary 需要使用 Metalsmith，因此在使用前需要安装 Metalsmith，安装命令：
npm install metalsmith --save-dev
在安装了 Metalsmith 之后，我们可以全局安装 Metalsmith-md-summary：
npm install -g metalsmith-md-summary
也可以在项目中安装：
npm install metalsmith-md-summary --save-dev
使用
创建一个存储 Markdown 文件的文件夹。在命令行中进入该文件夹，输入以下命令：
metalsmith-md-summary
即可将所有 Markdown 文件转换为 HTML，并生成目录摘要。
配置
Metalsmith-md-summary 也可以通过配置实现更多自定义设置。在项目根目录下创建一个名为 metalsmith.json 的配置文件，并输入以下内容：
-- -------------------- ---- -------
-
------------ --------------------
----------------- ----------------
-------- --- ---------
----------- -
-
------- -------
------- -------------
--
-
------- --------
------- -------------
-
-
-配置文件中，我们可以设定输入和输出的文件夹名称，网站标题和导航链接。
示例代码
下面是一个 JavaScript 示例代码，展示如何使用 Metalsmith-md-summary 创建一个简单的静态网站：
-- -------------------- ---- -------
----- ---------- - ----------------------
----- -------- - -------------------------------
----- ------- - ---------------------------------
---------------------
-----------
------ --- --------
--
--------------------
------------------------
------------
----------------
--------------
------ ------ -- ---------
---
------------ -- -
-- ----- ----- ----
---以上示例代码通过使用 Metalsmith 和 Metalsmith-md-summary，将 Markdown 文件转换为 HTML 并生成目录摘要。这个示例可以作为一个简单的静态网站的基础，您可以根据需要对其进行扩展。
总结
Metalsmith-md-summary 是一个方便的 NPM 包，可以在转换 Markdown 文件为 HTML 中添加目录摘要。本文介绍了如何使用该包，配置该包以及示例代码的编写。希望对大家在前端开发中有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005595d81e8991b448d6c24