vuepress-plugin-permalink-pinyin v1.1.0

vuepress-plugin-permalink-pinyin

A VuePress plugin which convert Chinese title to transliterate permalink.

/你今日饮咗未.md => /ni-jin-ri-yin-zuo-wei.html

Installation

Note: Work For VuePress 1.x.x

npm i vuepress-plugin-permalink-pinyin --save-dev
# or
yarn add vuepress-plugin-permalink-pinyin --dev

Usage

Modify your .vuepress/config.js and add into the plugins option.

plugins: ['permalink-pinyin']

Options

Pass any options of transliteration#slugify

plugins: {
  'permalink-pinyin': {
    lowercase: true, // Converted into lowercase, default: true
    separator: '-' // Separator of the slug, default: '-'
  }
}

Test

npm test

Related Projects

• Hexo version: https://github.com/viko16/hexo-permalink-pinyin

License

MIT License © viko16