vuepress-plugin-reading-progress-v2

a reading progress bar plugin for vuepress

README | CHANGELOG

add reading progress bar for vuepress

vuepress-plugin-reading-progress-v2

npm GitHub stars downloads GitHub license

vuepress-plugin-reading-progress-v2


Dependencies vuepress version

vuepress version v2.0.0+

Installation

yarn add vuepress-plugin-reading-progress-v2
# or
npm i vuepress-plugin-reading-progress-v2

Usage

module.exports = {
   plugins: [
      'reading-progress',
      {
         /** 是否展示进度条: 默认true */
         isSHowProgress: true,
         /** 自定义进度条的class: 默认‘’ */
         overrideClass: '',
         /** 进度条吸附位置:默认top; */
         fixed: 'top',
         /** 过滤哪些页面不展示进度条,默认[] */
         filterPages: [],
      },
   ],
}

Vuepress documentation

Thanks

License

MIT

GitHub

View Github