Reading info

Options See on deno.land

name string

The key name to store the reading info value and the filter

Default:

"readingInfo"

extensions string[]

The list extensions this plugin applies to

Default:

[ ".md" ]

wordsPerMinute number

The words per minute a reader can read (default: 275)

Default:

275

Description

This plugin creates the readingInfo variable in your pages with some interesting info about the page content, like the time to read or the number of pages.

Installation

Import this plugin in your _config.ts file to use it:

import lume from "lume/mod.ts";
import readInfo from "lume/plugins/reading_info.ts";

const site = lume();

site.use(readInfo());

export default site;

Usage

It uses the Int.Segmenter standard function to count the words, using the page variable lang to detect the language. The data is stored in the variable readingInfo, so you can use it in your templates in this way:

<p>{{ readingInfo.words }} words</p>
<p>{{ readingInfo.minutes }} min read</p>