HomeLogo

vuepress-plugin-reading-time1

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

# Plugin options

# wordPerminute

  • Type: number
  • Default: 300

Reading speed (words per minute)

# locales

interface ReadingTimeLocaleData {
  /**
   * Word template, `$word` will be automatically replaced by actual words
   */
  word: string;

  /**
   * Text for less than one minute
   */
  less1Minute: string;

  /**
   * Time template
   */
  time: string;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

Locales config.