阅读时间

一个轻巧的软件包，用于从给定的 markdown 文件中获取阅读时间信息。这是一个为想要分析读者阅读文章所需时间的作者而制作的工具。

安装

ReadingTime 使用 Swift Package Manager 分发。要在您的项目中安装和使用它，请将其作为依赖项添加到您的 Package.swift 文件中

let package = Package(
    ...
    dependencies: [
        .package(url: "https://github.com/pol-piella/reading-time.git", from: "1.0.0")
    ],
    ...
)

然后就可以像这样导入和使用了

import ReadingTime

用法

ReadingTime 的 API 非常简单。它由一个名为 ReadingTime 的枚举和静态方法 calculate 的两个变体组成。该计算返回以秒为单位的所提供的 markdown 内容的阅读时间估计值。

重要的是要注意，计算不将表情符号计为单词，markdown 图像每张增加一秒的阅读时间，并且 markdown 链接仅计算标题中的单词，而不是 URL。

计算字符串的阅读时间

要计算给定字符串的阅读时间，请使用 ReadingTime 中的 calculate(for content:wpm:) 方法。这需要两个参数：要解析的 String 和用于计算的每分钟字数。后者默认为 200。

let contents = "👋 Hello World! 🌍 This is my article! 🗞"
let calculatedTime = ReadingTime.calculate(for: contents) // Returns a TimeInterval type in seconds

计算文件的阅读时间

要计算 markdown 文件的阅读时间，请使用 ReadingTime 中的 calculate(for file:wpm:) 方法。这需要两个参数：要解析的文件的 URL 和用于计算的每分钟字数。后者默认为 200。

重要的是要注意，该方法可能会抛出 ReadingTimeError 类型的错误。

let fileURL = Bundle.module.url(forResource: "my-article", withExtension: "md")!
let calculatedTime = try ReadingTime.calculate(for: fileURL)

其他说明