介绍
metalsmith-metadata-in-filename 是一款基于 Node.js 平台的 npm 包,用于给文件名添加元数据并将其解析为 metalsmith 元数据对象。该包的主要功能是通过文件名为静态网站提供元数据。
安装
在使用之前,我们需要确保在本地电脑上已经安装了 Node.js 和 npm。接下来,我们可以在命令行中使用以下命令进行安装:
--- ------- ------------------------------- ----------
使用
使用 metalsmith-metadata-in-filename 的第一步就是将其加载到我们的项目中。我们需要在 metalsmith 插件列表中添加它,例如:
----- ---------- - ---------------------- ----- ------------------ - ------------------------------------------- ----- ---------- - ---------------------- -------------------------------------
然后,我们需要为文件名设置元数据,元数据位于文件名的开始处,并用两个横线隔开。例如:
---------------------------
这里的元数据是日期和文章标题,它们被平台无关的元数据指示符 (--) 隔开。接下来,metalsmith-metadata-in-filename 将这些元数据解析为具有相应属性值的 metadata 对象。
可以通过在配置文件中指定源目录和目标目录来设置文件名,以及通过使用 metalsmith-collection 插件将元数据放置在文档对象中,以便以后在模版中使用。
以下是示例代码:
----- ---------- - ---------------------- ----- ------------------ - ------------------------------------------- ----- ----------- - ---------------------------------- ----- -------- - ------------------------------- ----- ------- - ------------------------------- ----- ---------- - ---------------------- ------------------------------------ ------------------ --------- - -------- ------------------- ------- ------- -------- ---- - --- ---------------- ----------------
现在,metadata 就可以在模版中被访问了。例如,在 Handlebars 模版中,可以通过以下方式使用元数据:
------- ---------- ------------------ --------------- --- ---------
总结
metalsmith-metadata-in-filename 是一个非常有用的工具,可以为静态网站生成元数据,而不需要从文本或数据库中解析它们。本文介绍了如何在 metalsmith 项目中使用它以及如何将它与其他插件和模板引擎一起使用,以便在静态网站中轻松访问和使用元数据。
来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/6005597e81e8991b448d70be