Symbols count and time to read for articles.
npm install hexo-symbols-count-time[![npm-image]][npm-url]
[![node-image]][node-url]
[![hexo-image]][hexo-url]
[![cover-image]][cover-url]
[![travis-image]][travis-url]
[![appveyor-image]][appveyor-url]
[![lic-image]](LICENSE)
Symbols count and time to read for articles in Hexo blog.
Better than hexo-reading-time and faster than hexo-wordcount. No external dependencies.
![size-image]
[![dm-image]][npm-url]
[![dt-image]][npm-url]
``bash`
$ npm install hexo-symbols-count-time
You can set options of hexo-symbols-count-time in the Hexo's _config.yml (which locates in the root dir of your blog):
`yml`
symbols_count_time:
symbols: true
time: true
total_symbols: true
total_time: true
exclude_codeblock: false
awl: 4
wpm: 275
suffix: "mins."
If symbols_count_time option is not specified, the default parameters will be used.
* awl – Average Word Length (chars count in word). Default: 4. You can check this here.2
* CN ≈
* EN ≈
* RU ≈
* – Words Per Minute. Default: 275. You can check this here.200
* Slow ≈
* Normal ≈
* Fast ≈
* – If time to read less then 60 minutes, added suffix as string parameter.\mins.
If not defined, will be used as default.exclude_codeblock
* – Allow to exclude all content inside code blocks for more accurate words counting.\false
If not defined, will be used as default.
Note for Chinese users: because in Chinese language average word length about ~1.5 and if you at most cases write posts in Chinese (without mixed English), recommended to set awl to 2 and wpm to 300.\awl
But if you usualy mix your posts with English, to 4 and wpm to 275 will be nice.
This plugin integrated in «NexT» and after plugin enabled in main Hexo config, you may adjust options in NexT config:
`yml`
symbols_count_time:
separated_meta: true
item_text_post: true
item_text_total: false
`bash`
$ cd hexo
$ git clone https://github.com/theme-next/hexo-symbols-count-time.git node_modules/hexo-symbols-count-time
$ cd node_modules/hexo-symbols-count-time
`bash`
$ npm install mocha chai --save-dev
$ npm test
`bash`
$ npm install -g nyc
$ nyc --print both node_modules/.bin/_mocha -- test/index.js
#### Symbols Count
`js`
{{ symbolsCount(post) }}
#### Symbols Time
`js`
{{ symbolsTime(post) }}
Or with predefined parameters:
`js`
{{ symbolsTime(post, awl, wpm, suffix) }}
#### Symbols Count Total
`js`
{{ symbolsCountTotal(site) }}
#### Symbols Time Total
`js`
{{ symbolsTimeTotal(site) }}
Or with predefined parameters:
`js`
{{ symbolsTimeTotal(site, awl, wpm, suffix) }}
#### Renderers syntax
SWIG / Nunjucks: {{ template }}\<%-
EJS: template %>\span=
Jade: template`
[npm-image]: https://img.shields.io/npm/v/hexo-symbols-count-time?style=flat-square
[hexo-image]: https://img.shields.io/badge/hexo-%3E%3D%203.0-blue?style=flat-square
[node-image]: https://img.shields.io/node/v/hexo-symbols-count-time?style=flat-square
[cover-image]: https://img.shields.io/coveralls/theme-next/hexo-symbols-count-time/master?style=flat-square
[travis-image]: https://img.shields.io/travis/theme-next/hexo-symbols-count-time/master?style=flat-square
[appveyor-image]: https://img.shields.io/appveyor/ci/ivan-nginx/hexo-symbols-count-time/master?style=flat-square
[lic-image]: https://img.shields.io/npm/l/hexo-symbols-count-time?style=flat-square
[size-image]: https://img.shields.io/github/languages/code-size/theme-next/hexo-symbols-count-time?style=flat-square
[dm-image]: https://img.shields.io/npm/dm/hexo-symbols-count-time?style=flat-square
[dt-image]: https://img.shields.io/npm/dt/hexo-symbols-count-time?style=flat-square
[npm-url]: https://www.npmjs.com/package/hexo-symbols-count-time
[node-url]: https://nodejs.org/en/download/releases
[hexo-url]: https://hexo.io
[cover-url]: https://coveralls.io/github/theme-next/hexo-symbols-count-time?branch=master "Coverage of Tests"
[travis-url]: https://travis-ci.org/theme-next/hexo-symbols-count-time?branch=master "Travis CI [Linux]"
[appveyor-url]: https://ci.appveyor.com/project/ivan-nginx/hexo-symbols-count-time/branch/master "AppVeyor [Windows]"