#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

3 releases

0.1.2 Nov 23, 2024
0.1.1 Oct 27, 2024
0.1.0 Oct 26, 2024

#1641 in Command line utilities

Download history 240/week @ 2024-10-25 29/week @ 2024-11-01 5/week @ 2024-11-08 1/week @ 2024-11-15 138/week @ 2024-11-22 12/week @ 2024-11-29 15/week @ 2024-12-06

166 downloads per month

MIT license

11KB
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:

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

Dependencies

~12–22MB
~331K SLoC