meduza-static-site-generator/meduza-plugin-time-read

计算阅读时间插件

维护者

详细信息

github.com/meduza-static-site-generator/meduza-plugin-time-read

主页

源代码

问题

安装: 7

依赖项: 1

建议者: 0

安全: 0

星标: 0

关注者: 0

分支: 0

开放问题: 0

dev-main 2021-08-26 14:45 UTC

MIT cc85c0d467887ee36d8841fdbab5acef1ecdf806

phppluginstatic sitestatic site generatorphp8

This package is auto-updated.

Last update: 2024-09-26 21:38:54 UTC

README

计算页面阅读时间。

安装

推荐使用Composer进行安装

composer require meduza-static-site-generator/meduza-plugin-time-read

配置

插件配置非常简单

## Configuração do plugin time-read

plugins:
  TimeRead:
    # Caminho relativo/absoluto para o inicializador do plugin.
    source: "./vendor/meduza-static-site-generator/meduza-plugin-time-read/TimeRead.php"
    # Quantidade de palavras lidas por minuto.
    # Use valores de 175 ~ 300 ppm
    # https://blogue.rbe.mec.pt/quantas-palavras-por-minuto-le-um-2282282
    wordsPerMinute: 200

我们在项目根目录提供了一个名为time-read.yml的配置文件，其中包含了所有选项的文档。在您的配置文件中包含这些配置或使用import导入。

使用

Time Read提供阅读时间（分钟），供主题模板使用（前提是主题支持）。

基本原理

该插件为每个页面的frontmatter添加一个名为timeRead的键，它包含一个整数，表示页面内容的预估阅读时间（分钟）。

计算方法

目前，插件计算每个页面markdown部分的单词数，然后除以在wordsPerMinute中配置的值，向上取整。

如何贡献

  • 要为项目做出贡献，请执行以下操作
  • 创建一个fork；
  • 克隆fork并创建一个新分支用于您的贡献；
  • 将您的更改提交到fork；

创建一个pull request。

有兴趣创建一个包含您更改的官方存储库的issue，并在您的分支名称和提交中引用它。也请将您的pull request引用在issue中。这将加快您贡献的分析。

许可证