项目简介
本项目是一个VuePress插件,可将网站的URL路径转换为拼音,方便中文用户通过拼音访问页面,适合习惯使用拼音搜索或导航的用户,有助于提升网站的易用性与访问量。
项目的主要特性和功能
- 把Markdown文件标题转换为拼音作为URL路径,提供更友好的中文导航体验。
- 支持自定义词典和规则,满足不同的拼音需求。
- 可在VuePress项目中灵活配置和使用。
安装使用步骤
安装插件
使用npm安装插件:
bash
npm i vuepress-plugin-pinyin-urls -S
配置插件
在VuePress的配置文件 .vuepress/config.js
里引入并使用该插件:
javascript
module.exports = {
plugins: ["pinyin-urls"], // 尽可能将 'pinyin-urls' 放到最后以保证其生效
};
注意事项
若项目使用的Node版本小于13,可能会因缺少Intl或zh-CN语言支持而报错,解决办法如下:
安装full-icu
bash
npm install full-icu
或者全局安装:
bash
npm install -g full-icu
设置环境变量(仅对当前终端生效)
- Mac系统:
bash export NODE_ICU_DATA=/node_modules/full-icu
- Windows系统:
bash set NODE_ICU_DATA=/node_modules/full-icu
下载地址
点击下载 【提取码: 4003】【解压密码: www.makuang.net】