Skip to content

mdBook preprocessor that calculates word count and reading time

Notifications You must be signed in to change notification settings

pawurb/mdbook-reading-time

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

mdbook-reading-time Latest Version GH Actions

A processor for mdBook that calculates the reading time and word count of each chapter.

Usage

cargo install mdbook-reading-time

In book.toml

[preprocessor.reading-time]

This configuration replaces:

  • {{ #word_count }} with the number of words in the chapter.
  • {{ #reading_time }} with reading time, e.g. 9 minutes.

You can customize the default 200 WPM reading speed:

[preprocessor.reading-time]
words-per-minute = 250

About

mdBook preprocessor that calculates word count and reading time

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages