Metalsmith plugin to compute wordcount / average reading time of all paragraphs in a html file
npm install metalsmith-word-count#metalsmith-word-count
> Metalsmith plugin to compute wordcount / average reading time of all paragraphs in a html file.
Based on assemble-middleware-wordcount by Jon Schlinkert
Extracted from majodev.github.io.
As part the my note "Extracting libs from a node.js project: Publishing my metalsmith plugins".
``bash`
npm install --save metalsmith-word-count
`javascript
var Metalsmith = require("metalsmith");
var wordcount = require("metalsmith-word-count");
Metalsmith(__dirname)
// html files are available (e.g. state when markdown was compiled)
.use(wordcount())
// ...
`
Should also work in similar fashion with the metalsmith.json counterpart.
wordcount accepts an hash to provide a few customization options.
: Name of the key that will store the word count in a file's metadata.
default: wordCount$3
: Name of the key that will store the estimated reading time in a file's metadata.
default: readingTime$3
: How fast one normally reads, see http://onforb.es/1crk3KF
default: 300$3
: If readingTime should be outputted in seconds
default: false$3
: If readingTime should be returned as raw integer (in minutes or seconds)
default: falseFull example with options set
javascript
Metalsmith(__dirname)
// html files are available (e.g. state when markdown was compiled)
.use(wordcount({
metaKeyCount: "wordCount",
metaKeyReadingTime: "readingTime",
speed: 300,
seconds: false,
raw: false
}))
// ...
``