pengzhanbo 385059f214
docs: update en docs (#708)
* docs: update en docs

* chore: tweak

* chore: tweak

* chore: tweak
2025-10-09 15:46:05 +08:00

1.7 KiB

title, createTime, permalink
title createTime permalink
Reading Statistics 2025/10/09 15:23:39 /en/config/plugins/reading-time/

Overview

Generates word count and estimated reading time for each page.

Related plugin: @vuepress/plugin-reading-time

Default configuration:

import { defineUserConfig } from 'vuepress'
import { plumeTheme } from 'vuepress-theme-plume'

export default defineUserConfig({
  theme: plumeTheme({
    readingTime: {
      wordPerMinute: 300
    },
    // Can also be configured via plugins.readingTime, but not recommended
    plugins: {
      readingTime: {}
    }
  }),
})

Configuration

wordPerMinute

  • Type: number
  • Default: 300

Words read per minute.

locales

  • Type: ReadingTimePluginLocaleConfig

Internationalization configuration for the reading time plugin.

interface ReadingTimePluginLocaleData {
  /**
   * Word count template, where `$word` will be automatically replaced with the actual word count
   */
  word: string

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

  /**
   * Time template
   */
  time: string
}

interface ReadingTimePluginLocaleConfig {
  [localePath: string]: ReadingTimePluginLocaleData
}

Disabling

You can disable this feature by setting readingTime to false.

When disabled, article pages will not display word count and estimated reading time.

import { defineUserConfig } from 'vuepress'
import { plumeTheme } from 'vuepress-theme-plume'

export default defineUserConfig({
  theme: plumeTheme({
    readingTime: false
  }),
})