HomeLogo

@mr-hope/vuepress-plugin-reading-time

Expect reading time and word count statistics

This plugin will inject expect reading time and word count statistics into the page object.

Will automatically inject readingTime into the page object:

interface ReadingTime {
  /** Expect reading minute */
  minutes: number;
  /** Words count */
  words: number;
}
1
2
3
4
5
6

# How to use

# Install

# Usage

// .vuepress/config.js
module.exports = {
  plugins: [
    [
      "@mr-hope/reading-time",
      {
        // your options
      },
    ],
  ],
};
1
2
3
4
5
6
7
8
9
10
11

# Plugin options

# wordPerminute

  • Type: number
  • Default: 300

Reading speed (words per minute)