A Metalsmith plugin to estimate pages' reading times.
npm install --save metalsmith-reading-time
const Metalsmith = require('metalsmith');
const readingTime = require('metalsmith-reading-time');
Metalsmith(__dirname)
.use(readingTime({
// options here
}))
.build((err) => {
if (err) {
throw err;
}
});
This plugin adds a metadata field named readingTime
to each file which can be used with templating engines, such as with handlebars
:
Reading time will be reported in minutes in the form "# min read" per reading-time
.
Type: string
Default: **/*
A micromatch
glob pattern to find input files.
Type: boolean
Default: true
Whether to strip HTML tags from content before evaluating the reading time or not.
type: (string|RegExp)[][]
Default: []
A list of tuples fed to String.replace()
to get rid of meaningless content before evaluating the reading time.
Type: object
Default: {}
An object of reading-time
options, example:
{
"readingTime": {
"wordsPerMinute": 200
}
}