Skip to content

darrenjennings/vuepress-plugin-reading-time

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

vuepress-plugin-reading-time

reading time plugin to display how long a post takes to read

Npm build badge

yarn add -D vuepress-plugin-reading-time # OR npm install -D vuepress-plugin-reading-time

Usage

module.exports = { plugins: ['vuepress-plugin-reading-time'] }

Puts reading-time data into $page data so you can access like

console.log($page.readingTime)

Example output

{ text: '1 min read', minutes: 0.08, time: 4800, words: 16 }

Overide

You can override by specifying a readingTime object in frontmatter

--- title: My great post! date: "2018-08-13T17:36:55.338Z" readingTime: { text: "Not so long!", minutes: 3 } --- Some content here... 

Options

excludes

  • Type: Array<string>
  • Default: ``

Exclude pages by their path via a regular expression. This tests for both path and regularPath.

Example:

plugins: [ ['vuepress-plugin-reading-time', { excludes: ['/about', '/tag/.*'] }] ]

About

Vuepress reading time plugin to display how long a page takes to read

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published