首页
/ 推荐开源项目:reading_time — 智能阅读时间估计器

推荐开源项目:reading_time — 智能阅读时间估计器

2024-06-24 09:43:59作者:郜逊炳
reading_time
A Liquid filter to estimate how long a passage of text will take to read.

在信息爆炸的时代,估算一篇文章的阅读时间成为了提升用户体验的关键。这便是reading_time的作用所在。这是一个基于Liquid模板语言的过滤器插件,能够智能地计算HTML文本中的单词数量,并预测阅读完整篇文章所需的时间。

安装与使用

安装reading_time非常简单,只需要通过RubyGems运行命令gem install liquid_reading_time。如果你正在使用Jekyll,可参照Jekyll文档来安装插件。这个插件依赖于Nokogiri,因此手动安装时别忘了添加这个依赖。

在实际使用中,你可以利用两个提供的函数:

  1. reading_time 这个函数会返回一个整数,表示阅读输入文本所需的分钟数。例如,在Jekyll的布局文件中,可以这样使用:

    {% capture time %}{{ content | reading_time }}{% endcapture %}
    <p>这篇文章大约需要{{ time }}分钟阅读。</p>
    

    结合pluralize过滤器,还可以处理单复数形式:

    <p>这篇文章大约需要{{ content | reading_time | pluralize: "分钟" }}阅读。</p>
    
  2. count_words 此函数则返回输入文本中的单词总数,同样接受HTML作为输入。

精准计时与智能忽略

reading_timecount_words都试图以最聪明的方式计算单词。它们不会在以下HTML元素内部计数:area, audio, canvas, code, embed, footer, form, img, map, math, nav, object, pre, script, svg, table, track, 和 video。这种设计旨在避免那些非正文部分的词汇影响到总数。

该插件默认的阅读速度为每分钟270个单词,这个值基于一般人的阅读速率。

作者与版本历史

该项目由Benjamin Esham创建,并托管在GitHub上,欢迎提交Pull Request。

版本更新

  • v1.1.3 (2017-07-19): 更新了依赖,表明插件兼容Liquid 4。
  • v1.1.2 (2015-03-07): 改进了单词分割规则,增加了单元测试,并支持Liquid 3.x。
  • 更多版本信息,请参考项目仓库的历史记录。

许可证

reading_time遵循ISC许可证,详细信息可在LICENSE.md文件中查看。

总之,无论你是个人博客作者还是企业网站开发者,reading_time都是一个值得采用的工具,它将帮助你的读者更好地管理他们的时间,提高他们的浏览体验。现在就尝试集成并享受更智能的阅读统计吧!

reading_time
A Liquid filter to estimate how long a passage of text will take to read.
热门项目推荐
相关项目推荐

项目优选

收起
CangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
669
0
RuoYi-Vue
🎉 基于SpringBoot,Spring Security,JWT,Vue & Element 的前后端分离权限管理系统,同时提供了 Vue3 的版本
Java
136
18
openHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
12
7
redis-sdk
仓颉语言实现的Redis客户端SDK。已适配仓颉0.53.4 Beta版本。接口设计兼容jedis接口语义,支持RESP2和RESP3协议,支持发布订阅模式,支持哨兵模式和集群模式。
Cangjie
322
26
advanced-java
Advanced-Java是一个Java进阶教程,适合用于学习Java高级特性和编程技巧。特点:内容深入、实例丰富、适合进阶学习。
JavaScript
75.83 K
19.04 K
qwerty-learner
为键盘工作者设计的单词记忆与英语肌肉记忆锻炼软件 / Words learning and English muscle memory training software designed for keyboard workers
TSX
15.56 K
1.44 K
Jpom
🚀简而轻的低侵入式在线构建、自动部署、日常运维、项目监控软件
Java
1.41 K
292
Yi-Coder
Yi Coder 编程模型,小而强大的编程助手
HTML
30
5
easy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
1.42 K
231
taro
开放式跨端跨框架解决方案,支持使用 React/Vue/Nerv 等框架来开发微信/京东/百度/支付宝/字节跳动/ QQ 小程序/H5/React Native 等应用。 https://taro.zone/
TypeScript
35.34 K
4.77 K