Overview

The VuePress Reading Time plugin is a versatile tool designed to enhance the user experience by displaying the estimated reading time for blog posts and articles. With the increasing consumption of online content, understanding how long it will take to read a piece can be immensely helpful for readers. This plugin simplifies that process, allowing content creators to integrate reading time information seamlessly into their VuePress projects.

This plugin provides robust features, enabling customization and control over how reading time is calculated and displayed. Whether you want to show this data across all posts or exclude certain pages, this plugin has you covered.

Features

• Reading Time Display: Automatically calculates and displays the estimated reading time for each post, giving readers a quick insight into how long they might need to spend.

• Npm Build Badge: Easily integrates with your development workflow by using an Npm build badge, ensuring you’re using the latest version of the plugin.

• $page Data Access: Integrates reading-time data directly into the $page data, allowing for easy access and manipulation within your VuePress components.

• Customizable Overrides: Offers the ability to override default settings by defining a readingTime object in the frontmatter of your posts, providing flexibility for content creators.

• Exclusion Options: Includes functionality to exclude specific pages from showing reading time estimates using a regular expression to match paths, ensuring you have full control over what gets displayed.

• Regular Expression Testing: Supports testing both path and regularPath with regular expressions, allowing for advanced customization in managing your content’s visibility.