Metalsmith 是一个 Node.js 静态网站生成器,而 metalsmith-url
是一个 Metalsmith 插件,用于为静态网站中的文件设置 URL。本文将详细介绍如何使用这个插件。
1. 安装 metalsmith-url
在使用 metalsmith-url 之前,需要先安装它。可以通过以下命令在项目中安装:
npm install --save metalsmith-url
2. 在 Metalsmith 中使用 metalsmith-url
在安装完成后,在 Metalsmith 的配置文件中引入 metalsmith-url
并将其添加到你要使用的 Metalsmith 插件列表中:
-- -------------------- ---- ------- ----- ---------- - ---------------------- ----- --- - -------------------------- --------------------- ----------- ------------ -- - -- ----- ----- ---- ------------------ ------------ ---
在上面的代码中,我们使用 require
引入了 metalsmith-url
模块,并将其作为 Metalsmith 插件使用。
3. 配置 metalsmith-url
metalsmith-url
插件会自动从文件路径中推断出 URL,但是你也可以手动指定一个 URL:
.use(url({ // 这里指定了文章的 URL 格式 pattern: ':title' }))
在这个例子中,我们使用 pattern
选项来指定 URL 的格式。metalsmith-url
默认情况下是将文件名作为 URL,但是你可以使用一些特殊的占位符来生成自定义 URL。例如,在上面的代码中,我们使用 :title
占位符将文件名替换为文章标题。
以下是一些常用的占位符:
:basename
:文件名(不包括扩展名):dirname
:文件所在目录:ext
:文件扩展名:name
:文件名(包括扩展名):title
:文件名作为标题格式化
你还可以在 relative
选项中指定一个相对路径,以便将 URL 转换为相对于指定路径的 URL:
.use(url({ // 使用相对路径将 URL 转换为相对于 /blog 的 URL relative: '/blog' }))
示例代码
-- -------------------- ---- ------- ----- ---------- - ---------------------- ----- --- - -------------------------- --------------------- ---------------- ----------------------- ---------- -------- --------- --------- ------- --- ------------ -- - -- ----- ----- ---- ------------------ ------------ ---
以上就是如何使用 metalsmith-url
插件的详细教程。希望这篇文章能够帮助你更好地使用 Metalsmith 创建静态网站。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/47760