Crate markdown_readtime 

markdown-readtime

一个用于估算 Markdown 内容阅读时间的 Rust 库。

功能特性

• 📊 准确估算 Markdown 文本的阅读时间
• 🌍 支持中英文文本
• 😊 Emoji 处理支持
• 🖼️ 图片阅读时间计算
• 💻 代码块阅读时间计算
• ⚙️ 可自定义阅读速度参数
• 📦 轻量级，零依赖（可选 serde 支持）

快速开始

基础用法

use markdown_readtime::{estimate, minutes, words, formatted};

let markdown_content = r#"

这是一些示例内容，用来演示如何使用 markdown-readtime 库。

# 子标题

我们还可以添加一些列表:
- 第一项
- 第二项
- 第三项
"#;

// 获取完整的阅读时间信息
let read_time = estimate(markdown_content);
println!("总阅读时间: {}秒", read_time.total_seconds);
println!("格式化时间: {}", read_time.formatted);
println!("字数统计: {}", read_time.word_count);

// 或者使用快捷函数
println!("预计需要 {} 分钟读完", minutes(markdown_content));
println!("大约有 {} 个字", words(markdown_content));
println!("阅读时间: {}", formatted(markdown_content));

自定义阅读速度

use markdown_readtime::{estimate_with_speed, ReadSpeed};

let markdown_content = "# 示例文章\n\n这是用来测试的文章内容。";

// 创建自定义阅读速度配置
let speed = ReadSpeed::default()
    .wpm(180.0)             // 设置每分钟阅读180个词
    .image_time(15.0)       // 每张图片额外增加15秒
    .code_block_time(25.0)  // 每个代码块额外增加25秒
    .emoji(true)            // 考虑emoji
    .chinese(true);         // 中文模式

let read_time = estimate_with_speed(markdown_content, &speed);
println!("自定义配置下的阅读时间: {}秒", read_time.total_seconds);

Structs

ReadSpeed

阅读速度配置

ReadTime

阅读时间估算结果

Functions

estimate

估算Markdown的阅读时间

estimate_with_speed

使用自定义速度配置估算阅读时间

formatted

快捷函数：获取格式化字符串

minutes

快捷函数：获取分钟数

words

快捷函数：获取单词数