#mdbook #word-count #reading #time #chapter #preprocessor #minutes

bin+lib mdbook-reading-time

mdbook preprocessor that calculates the reading time and word count of each chapter

2 releases

0.1.1 Oct 27, 2024
0.1.0 Oct 26, 2024

#1721 in Command line utilities

Download history 41/week @ 2024-10-20 214/week @ 2024-10-27

255 downloads per month

MIT license

18KB
168 lines

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 like this:

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

Dependencies

~11–23MB
~330K SLoC