#reading #word-count #time #mdbook #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

#1960 in Command line utilities

Download history 1/week @ 2024-11-13 131/week @ 2024-11-20 17/week @ 2024-11-27 10/week @ 2024-12-04 10/week @ 2024-12-11 2/week @ 2024-12-18 95/week @ 2024-12-25 926/week @ 2025-01-01 136/week @ 2025-01-08 17/week @ 2025-01-22 39/week @ 2025-02-05 43/week @ 2025-02-12 23/week @ 2025-02-19 8/week @ 2025-02-26

113 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

~13–25MB
~377K SLoC