Skip to content

更新日志

Blog

📝 更新日志

🎉 v1.0.0 - 首次发布 (2025-06-06)

✨ 主要特征

📊 智能阅读时间统计

  • 自动计算文档阅读时间，基于中文阅读速度（300字/分钟）
  • 精准统计中文字符数量，排除标点符号和空格
  • 智能识别并统计有效代码行数
  • 支持多种 Markdown 格式和代码块

🎨 美观的显示界面

  • 使用 Material for MkDocs 的 info 样式框展示统计信息
  • 清晰的图标和排版设计（📖 阅读信息）
  • 响应式设计，适配各种设备屏幕

⚙️ 灵活的配置选项

  • 支持页面级别的排除设置（hide_reading_time: true）
  • 正则表达式模式匹配，批量排除特定页面
  • 可自定义统计信息显示格式
  • 支持本地预览和生产环境部署
🚀 核心功能
  1. 阅读时间计算
  2. 基于中文阅读习惯的智能算法
  3. 区分正文内容和代码内容

  4. 自动排除 Markdown 语法标记

  5. 内容统计分析

  6. 中文字符精确计数
  7. 代码行数统计（排除空行和注释）

  8. 多语言内容混合处理

  9. 页面排除机制

  10. 元数据标记排除：hide_reading_time: true
  11. 路径模式排除：支持正则表达式

  12. 预设排除页面：首页、索引页等

  13. 集成部署

  14. 简单的 Hook 机制集成
  15. 零依赖，纯 Python 实现
  16. 兼容 MkDocs 生态系统
🛠️ 技术规格
  • 兼容性: Python 3.7+
  • 框架支持: MkDocs + Material for MkDocs
  • 核心依赖: 标准库 re 模块
  • 文件大小: 轻量级，单文件实现
  • 性能: 高效处理，对构建速度影响微乎其微
📦 安装使用

下载地址: GitHub Release 

1
2
3
4
5
6
7
# mkdocs.yml 配置
hooks:
  - docs/overrides/hooks/reading_time.py

theme:
  name: material
  custom_dir: docs/overrides
🎯 适用场景
  • 📚 技术文档网站
  • 📝 个人博客
  • 📖 知识库系统
  • 🏢 企业文档平台
  • 🎓 教育培训材料
🔧 自定义配置示例
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
# 排除特定页面
EXCLUDE_PATTERNS = [
    re.compile(r'^index\.md$'),
    re.compile(r'^blog/posts\.md$'),
    re.compile(r'404\.md$'),
]

# 自定义显示格式
reading_info = f"""!!! info "📖 阅读信息"
    阅读时间：**{reading_time}** 分钟 | 中文字符：**{chinese_chars}** | 代码行数：**{code_lines}**
"""
🎨 效果预览

统计信息将以如下格式显示在文档顶部：

📖 阅读信息

阅读时间：5 分钟 | 中文字符：1,234 | 有效代码行数：42

🔮 后续规划
  • 集成 AI 摘要功能
  • 支持多语言阅读速度配置
  • 添加阅读进度条功能
  • 支持更多主题样式
  • 提供阅读统计报告

问题反馈: GitHub Issues