PHPackages                             pixelsushirobot/kirby-readingtime - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. pixelsushirobot/kirby-readingtime

ActiveKirby-plugin

pixelsushirobot/kirby-readingtime
=================================

Estimates the reading time for any Kirby text field. Modernized for Kirby 3/4/5.

3.0.2(1mo ago)030↓75%MITPHPPHP >=8.0

Since Jul 12Pushed 1mo agoCompare

[ Source](https://github.com/PixelSushiRobot/kirby-readingtime)[ Packagist](https://packagist.org/packages/pixelsushirobot/kirby-readingtime)[ RSS](/packages/pixelsushirobot-kirby-readingtime/feed)WikiDiscussions master Synced 1w ago

READMEChangelog (3)Dependencies (1)Versions (4)Used By (0)

Reading Time (Kirby 5)
======================

[](#reading-time-kirby-5)

Estimates the reading time for any Kirby text field. A modernized fork of the archived [getkirby-v2/readingtime-plugin](https://github.com/getkirby-v2/readingtime-plugin), rewritten for the Kirby 3/4/5 plugin API.

What's different from the original
----------------------------------

[](#whats-different-from-the-original)

- Registered via the modern `Kirby::plugin()` / `fieldMethods` API (works on Kirby 3, 4 and 5).
- **Configurable words-per-minute** via a plugin option (default `200`).
- **KirbyText-aware word count**: text is parsed and tag-stripped before counting, so Markdown/KirbyTag syntax isn't counted as words.
- Ships with `composer.json` and a version constant.

Installation
------------

[](#installation)

### Manual

[](#manual)

Copy the `readingtime` folder into `/site/plugins`.

### Composer

[](#composer)

```
composer require pixelsushirobot/kirby-readingtime

```

Usage
-----

[](#usage)

```

```

Outputs e.g. `4 minute read`, or `35 second read` for sub-minute content.

Configuration
-------------

[](#configuration)

Set a global words-per-minute in `site/config/config.php`:

```
return [
    'pixelsushirobot.readingtime.wpm' => 240
];
```

Or override per call, along with labels and format:

```