#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

#1855 in Command line utilities

Download history 216/week @ 2024-10-27 15/week @ 2024-11-03 2/week @ 2024-11-10 84/week @ 2024-11-17 62/week @ 2024-11-24 6/week @ 2024-12-01 14/week @ 2024-12-08 5/week @ 2024-12-15 679/week @ 2024-12-29 462/week @ 2025-01-05 16/week @ 2025-01-12 7/week @ 2025-01-19 10/week @ 2025-01-26 24/week @ 2025-02-02 22/week @ 2025-02-09

63 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–24MB
~354K SLoC