Reading Statistics
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
},
}),
})For configuration entry priority information, please refer to Plugin Configuration Entry.
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
*/
subMinute: 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
}),
})