PHPackages grommasdietz/kirby-proofreader - 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. [Utility & Helpers](/categories/utility) 4. / 5. grommasdietz/kirby-proofreader ActiveKirby-plugin[Utility & Helpers](/categories/utility) grommasdietz/kirby-proofreader ============================== Typographic suggestions for Kirby CMS 1.7.0(3w ago)5296—8.8%MITPHPPHP ^8.2CI passing Since May 8Pushed 1w agoCompare [ Source](https://github.com/grommasdietz/kirby-proofreader)[ Packagist](https://packagist.org/packages/grommasdietz/kirby-proofreader)[ RSS](/packages/grommasdietz-kirby-proofreader/feed)WikiDiscussions main Synced 1w ago READMEChangelog (10)Dependencies (4)Versions (16)Used By (0) Kirby Proofreader ================= [](#kirby-proofreader) Kirby Proofreader adds a Panel button on Kirby CMS for reviewing typographic corrections in page, site and file metadata before applying them. Field changes are saved to Kirby's changes version, title fixes use Kirby's native title action and save immediately. [![Cover image showing an example of the plugin in use](/.github/assets/hero-image.png)](/.github/assets/hero-image.png) Requirements ------------ [](#requirements) - Kirby 5+ - PHP 8.2+ Installation ------------ [](#installation) ``` composer require grommasdietz/kirby-proofreader ``` Tip If you don’t use Composer, you can download this repository and copy it to `site/plugins/kirby-proofreader`. Quickstart ---------- [](#quickstart) Add the button to a page, site or file blueprint: ``` buttons: proofreader: true languages: true status: true settings: true ``` ### Options [](#options) The default rule order is `unicode`, `ellipsis`, `quotes`, `apostrophes`, `dashes`, `spaces`. `dimensions` is a predefined optional rule for values such as `5 x 5 cm`. Rules can be reordered, disabled or extended. Configure via `site/config/config.php`: ``` return [ 'grommasdietz.proofreader.rules' => [ 'unicode', 'ellipsis', 'quotes' => false, 'apostrophes', 'dashes', 'spaces', 'dimensions', 'trademark' => [ 'label' => 'Trademark', 'callback' => static fn (string $text): string => str_replace( 'Label TM', 'Label™', $text ), ], ], ]; ``` > The keyed `false` entry disables the built-in `quotes` rule. The keyed `trademark` array adds a custom callback rule. Quote characters, dash characters and dash spacing follow Kirby's native SmartyPants options when configured globally or per language. Single-language installs need SmartyPants configuration to enable quote rule. Default field coverage includes `text`, `textarea`, `writer`, `list`, `structure`, `blocks` and `layout` fields. Custom field names or types can be included or excluded: ``` return [ 'grommasdietz.proofreader.fields' => [ 'include' => [ 'types' => [ 'custom-writer' => 'html', 'custom-text' => 'plain', 'custom-structure' => 'structure', ], 'names' => [ 'intro' => 'plain', ], ], 'exclude' => [ 'types' => ['text', 'textarea'], 'names' => ['intro'], ], ], ]; ``` Use `grommasdietz.proofreader.protect` to prevent specific text spans from being modified by any rule. The built-in `phone` preset protects international (`+49 89 …`) and domestic chained (`0800-123-4567`) numbers. Arbitrary regex patterns are accepted for other span types: ``` return [ 'grommasdietz.proofreader.protect' => [ 'phone' => true, 'skuPattern' => '/\bSKU-\d+-\d+\b/u', ], ]; ``` ### CLI [](#cli) With the [Kirby CLI](https://github.com/getkirby/cli) installed, fixes can also be applied from the command line: ``` # Preview suggestions (read-only) kirby proofreader:review projects/my-project # Fix a page (saved as unpublished changes) kirby proofreader:fix projects/my-project # Fix all pages and publish immediately kirby proofreader:fix --all --publish # Dry-run batch fix kirby proofreader:fix --all --dry-run ``` See [docs/usage/index.md](docs/usage/index.md) for the full flag reference. ### Documentation [](#documentation) Full reference for [usage](docs/usage/index.md), [contributions](docs/contributions/index.md) and [maintenance](docs/maintenance/index.md) lives in [documentation](docs/index.md). --- Changelog --------- [](#changelog) See [CHANGELOG.md](CHANGELOG.md) for version history and changes. --- Security -------- [](#security) See [SECURITY.md](SECURITY.md) for security policies and reporting vulnerabilities. --- Contributing ------------ [](#contributing) See [CONTRIBUTING.md](CONTRIBUTING.md) for guidance and expectations. --- License ------- [](#license) [MIT](LICENSE.md) © 2026 Grommas Dietz ### Health Score 48 — FairBetter than 94% of packages Maintenance97 Actively maintained with recent releases Popularity22 Limited adoption so far Community8 Small or concentrated contributor base Maturity54 Maturing project, gaining track record Bus Factor1 Top contributor holds 81.3% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~1 days Total 13 Last Release 22d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/0bb3d1cab7f30711576ede9d0547977e67d14de0fb70ab1b417ced695bb1d8f6?d=identicon)[grommasdietz](/maintainers/grommasdietz) --- Top Contributors [![semantic-release-bot](https://avatars.githubusercontent.com/u/32174276?v=4)](https://github.com/semantic-release-bot "semantic-release-bot (13 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (3 commits)") --- Tags kirbykirby-pluginkirby-cms ### Code Quality TestsPHPUnit Static AnalysisPsalm Code StylePHP CS Fixer Type Coverage Yes ### Embed Badge ![Health badge](/badges/grommasdietz-kirby-proofreader/health.svg) ``` [![Health](https://phpackages.com/badges/grommasdietz-kirby-proofreader/health.svg)](https://phpackages.com/packages/grommasdietz-kirby-proofreader) ``` ### Alternatives [medienbaecker/kirby-modules Easily add modules to your pages 885.4k1](/packages/medienbaecker-kirby-modules)[belugadigital/kirby-navigation Kirby 5 field for hierarchical menus with drag & drop level indentation. 8613.8k](/packages/belugadigital-kirby-navigation)[bnomei/kirby3-dotenv Kirby Plugin for environment variables from .env 4147.7k1](/packages/bnomei-kirby3-dotenv)[bnomei/kirby3-recently-modified Kirby Section to display recently modified content pages 3210.2k](/packages/bnomei-kirby3-recently-modified)[grommasdietz/kirby-hidden-characters Kirby CMS plugin for visualising hidden characters in the Panel 461.6k](/packages/grommasdietz-kirby-hidden-characters)[bnomei/kirby3-robots-txt Manage a virtual robots.txt from the Kirby config file 2249.7k](/packages/bnomei-kirby3-robots-txt) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)