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