1. 介绍
metalsmith-related 是一个基于 metalsmith 的插件，用于生成相关文章列表。该插件支持自定义关联文章生成规则，提供了丰富的配置选项，可根据需求生成多种相关文章列表。
本文将带你深入了解 metalsmith-related 的使用方法，包括插件安装、配置、使用等内容，帮助你快速掌握该插件的使用技巧。
2. 安装
使用 npm 进行安装：
npm install metalsmith-related --save
3. 配置
在 metalsmith 配置文件中，添加 related 插件，并设置相关选项：
-- -------------------- ---- -------
----- ---------- - ----------------------
----- ------- - ------------------------------
---------------------
--------------
-- ----
---
------------ -- -
-- ----- ----- ----
------------------ -----------
---插件选项：
-- -------------------- ---- ------- - -- ---------------- --------- ------------- ---------- -- -------------- - ------ -- -- ------------------ ----- ----- -- ------------------ ----------- ----- -- -------------- ------------ ------ -- - ---------- --------------- ------ ------ -------- ------------ -
4. 使用
在 markdown 文件头部添加相关属性，用于生成相关文章列表：
-- -------------------- ---- ------- --- ------ -- ------- ----- ---------- ----- - ---------- -------- - ---------- - ------------------ ---
上述示例中，文章会列出 example.md 和 another-example.md 两篇文章。
除了手动指定相关文章外，metalsmith-related 还支持从标签或分类中自动生成相关文章列表。只需将插件选项中对应属性设置为 true 即可：
Metalsmith(__dirname)
.use(related({
tags: true, // 从标签中自动生成相关文章列表
categories: true, // 从分类中自动生成相关文章列表
}))
.build((err) => {
// ...
});5. 总结
metalsmith-related 是一款强大的文章相关性生成插件。本文介绍了该插件的使用方法，包括安装、配置和使用等内容。
通过使用 metalsmith-related，你可以很方便地生成与当前文章有关联的文章列表。在文章阅读体验上，有很大的提升。希望本文能帮助你更好地利用该插件，提高文章阅读质量。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60066f411d8e776d08040d33