Package Exports

vuepress-plugin-permalink-pinyin
vuepress-plugin-permalink-pinyin/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (vuepress-plugin-permalink-pinyin) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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

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