什么是 hexo-helper-slugify
hexo-helper-slugify 是一个 npm 包,它可以将字符串转化为 URL 友好的 slug,并提供了一些自定义选项,使用户可以更灵活地控制 slug 的生成过程。在 hexo 博客开发中,slug 是博客文章的标识符,通常在 URL 中使用,它应该是有意义的、易于记忆和传播的。hexo-helper-slugify 的出现使得博客文章 slug 的生成变得更加方便和规范。
安装 hexo-helper-slugify
使用 npm 安装 hexo-helper-slugify 十分简单,只需要在控制台运行以下命令即可:
npm install hexo-helper-slugify --save
使用方法
安装完成后,便可以在 hexo 项目中使用 hexo-helper-slugify 包中提供的方法。使用时,需要在 hexo 的配置文件 _config.yml
中开启 slug 自动生成功能,如下:
permalink: :year/:month/:day/:slug/
其中 :slug
部分即为使用 slugify 生成的 slug。
在 hexo 的博客文章中,即可使用 page.slug
访问 hexo-helper-slugify 生成的 slug。
如果需要对 slug 生成过程进行定制化,例如指定特定字符作为 slug 分隔符,指定需要转化的字符集等,可以使用 hexo-helper-slugify 中提供的一些参数。以下是几个常用的参数示例:
- separator:指定字符作为 slug 的分隔符。例如,将
hello-world.md
转化为hello_world
:
<%- slugify(page.title, {separator: '_'}) %>
- lowercase:将 slug 转化为小写格式。例如,将
Hello-World.md
转化为hello-world
:
<%- slugify(page.title, {lowercase: true}) %>
- replace:将原字符串中的特定字符替换为指定字符。例如,将
hello,world.md
转化为hello+world
:
<%- slugify(page.title, {replace: {',': '+'}}) %>
示例代码
以下是一段常用的 post
slug 生成示例代码:
-- -------------------- ---- ------- -- ----------- ---- ---------- ------------------------ -- ------------ -- --- ------ ---------- ----- ---------- ----- - -- ----------- - ---- --- -- --------- --- ---- --- ------------------- -- -- ------- ---------------------------------
以上示例代码可以在 hexo 博客项目中使用,快速生成规范、易于访问的 slug。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/600569fd81e8991b448e4f59