vuepress-plugin-reading-progress

a reading progress bar plugin for vuepress.

This plugin is for Vuepress 1.x which is currently in alpha

add reading progress bar for vuepress.

vuepress-plugin-reading

Installation

yarn add vuepress-plugin-reading-progress
// or
npm i vuepress-plugin-reading-progress

Usage

module.exports = {
  plugins: [
    'reading-progress'
  ]
}

Vuepress documentation

Options

readingDir

  • Type: null, string, array, Object
  • Default: null

Specify folders that display reading progress bar

example

{
  readingDir: 'posts'
  // or
  readingDir: ['posts1', 'posts2', 'posts3']
  // or { dir: fixed }
  readingDir: {
    posts1: 'top',
    posts2: 'bottom',
    posts3: 'left'
  }
}

fixed

  • Type: string
  • Default: top

support top, bottom, left, right

set position for reading progress bar

Front matter

Change the reading progress bar display of the current page by use readingShow

---
readingShow: false
---
// or
---
readingShow: true
---

Style

If you wish to apply simple color overrides to the styling

+- .vuepress
  +- styles
    +- palette.styl

$readingBgColor = transparent
$readingZIndex = 1000
$readingSize = 3px
$readingProgressColor = $accentColor
$readingProgressImage = none

example

$readingProgressImage = linear-gradient(-150deg, #E50743 0%, #F9870F 15%, #E8ED30 30%, #3FA62E 45%, #3BB4D7 60%, #2F4D9E 75%, #71378A 80%)

GitHub