mdbook-reading-time

Crates.iomdbook-reading-time
lib.rsmdbook-reading-time
version0.1.1
sourcesrc
created_at2024-10-26 22:23:09.017319
updated_at2024-10-27 20:16:58.32854
descriptionmdbook preprocessor that calculates the reading time and word count of each chapter.
homepage
repository
max_upload_size
id1424188
size64,384
Paweł Urbanek (pawurb)

documentation

README

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
Commit count: 0

cargo fmt