在前端开发中，经常需要用到 markdown 来编写文档、博客等内容。而 metalsmith-better-excerpts 是一个能够为 markdown 文章自动生成摘要的 npm 包，使用起来非常方便。本文将为大家介绍如何使用它，并提供详细的示例代码。
安装
首先我们需要安装该 npm 包。可以在命令行中输入以下命令：
--- ------- -------------------------- ------
使用方法
使用 metalsmith-better-excerpts 生成文章摘要非常简单，只需要在 metalsmith 的配置文件中加入以下代码即可：
----- -------- - ------------------------------------- --------------------- ---------------- --------
使用上述方式生成的摘要默认截取前 5 句话。如果希望指定摘要长度，可以传递 options 对象，示例代码如下：
----- -------- - -------------------------------------
---------------------
---------------
------------ ---- -- ------- --- -
------------ ---- -- ----------- ----
---
--------默认情况下，metalsmith-better-excerpts 获取文章的第一段作为摘要。如果文章的第一段是标题或者图片等内容，可能不适合用来做摘要。因此，我们可以通过传递 selector 选项来指定获取哪个元素。
例如，如果希望获取 markdown 文件中第一个以 h2 标签开头的段落作为摘要，可以使用以下代码：
----- -------- - -------------------------------------
---------------------
---------------
--------- ----------------- - -- -- ------ -- -----
---
--------示例代码
- ----- ----- ------------------- --------------------------- -- ---- ---------- -- ---- ---------- -- ---- ----------
----- -------- - -------------------------------------
---------------------
----------------------
-----------------------
---------------
--------- ----------------- - --
---
---------- -- -
-- ----- ----- ---
------------------ ------------
--生成的摘要内容：
------------------- ---------------------------
总结
在本文中，我们介绍了如何使用 metalsmith-better-excerpts 生成 markdown 文章的摘要，并提供了详细的示例代码。通过阅读本文，你可以更加便捷地在自己的项目中使用这个工具。同时，也建议大家在编写文章时尽可能为其添加摘要，方便读者快速了解文章内容。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/85553