Plugin for Hexo CMS to display reading time for article
JavaScript
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
.editorconfig
.eslintrc.json
.gitignore
LICENSE
README.md
index.js
package.json

README.md

hexo-reading-time

Hexo plugin that displays reading time for the article.

Installation

npm install --save hexo-reading-time

Usage

Basic Usage

To display reading time, add the function into post.ejs.

Ejs:

<%- readingTime(page.content) %>

Swig:

{{ readingTime(page.content) }}

Jade:

span= readingTime(page.content)

It will display X min. read.

Customization

You can cutomize the output by passing additional arguments.

Ejs:

<%- readingTime(page.content, 'min.', wordsperminute) %>

Swig:

{{ readingTime(page.content, 'min.', wordsperminute) }}

Jade:

span= readingTime(page.content, 'min.', wordsperminute)

where:
'min.' - second argument - any string that represents suffx. Default is 'min. read'
wpm - number - words per minute. Default is 150.
Both arguments are optional.

License

MIT