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

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

2024-06-24 09:43:59作者:郜逊炳

在信息爆炸的时代,估算一篇文章的阅读时间成为了提升用户体验的关键。这便是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都是一个值得采用的工具,它将帮助你的读者更好地管理他们的时间,提高他们的浏览体验。现在就尝试集成并享受更智能的阅读统计吧!

热门内容推荐

项目优选

收起
Python-100-DaysPython-100-Days
Python - 100天从新手到大师
Python
263
54
国产编程语言蓝皮书国产编程语言蓝皮书
《国产编程语言蓝皮书》-编委会工作区
65
17
open-eBackupopen-eBackup
open-eBackup是一款开源备份软件,采用集群高扩展架构,通过应用备份通用框架、并行备份等技术,为主流数据库、虚拟化、文件系统、大数据等应用提供E2E的数据备份、恢复等能力,帮助用户实现关键数据高效保护。
HTML
85
63
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
53
44
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
196
45
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
268
69
xxl-jobxxl-job
XXL-JOB是一个分布式任务调度平台,其核心设计目标是开发迅速、学习简单、轻量级、易扩展。现已开放源代码并接入多家公司线上产品线,开箱即用。
Java
9
0
RuoYi-VueRuoYi-Vue
🎉 基于SpringBoot,Spring Security,JWT,Vue & Element 的前后端分离权限管理系统,同时提供了 Vue3 的版本
Java
171
41
RuoYi-Cloud-Vue3RuoYi-Cloud-Vue3
🎉 基于Spring Boot、Spring Cloud & Alibaba、Vue3 & Vite、Element Plus的分布式前后端分离微服务架构权限管理系统
Vue
38
24
qwerty-learnerqwerty-learner
为键盘工作者设计的单词记忆与英语肌肉记忆锻炼软件 / Words learning and English muscle memory training software designed for keyboard workers
TSX
332
27