grommasdietz / kirby-proofreader

1.13.0 2026-10-22 20:41 UTC

Requires

• php: ^8.2
• getkirby/composer-installer: ^1.2

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.93
• getkirby/cms: ^5.2
• phpunit/phpunit: ^12.5
• vimeo/psalm: ^6.19.1

MIT

• Grommas Dietz

• kirby
• kirby-plugin
• kirby-cms
• kirby5

Published on Packagist.org on 2026-10-22 20:41 UTC

README

Kirby Proofreader adds a Panel button on Kirby CMS for reviewing typographic corrections in content views before applying them. Field changes are saved to Kirby's changes version, title fixes use Kirby's native title action and save immediately.

Requirements

• Kirby 5.2+
• PHP 8.2+

Installation

composer require grommasdietz/kirby-proofreader

Tip

For a manual install, download the Source code (zip) archive of an immutable GitHub release tag and copy it to site/plugins/kirby-proofreader.

Quickstart

Add the button to a page, site, file, user or custom area blueprint:

buttons:
  proofreader: true
  languages: true
  status: true
  settings: true

Options

The default rule order is unicode, ellipsis, quotes, apostrophes, dashes, spaces. Optional rules include dimensions, paragraphs, abbreviations, primes, currencies and symbols. 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',
        'paragraphs',
        '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 and spacing follow Kirby's native SmartyPants options when configured globally or per language. Regional styles belong in Kirby's language definitions. HTML lang attributes override the content language, and quotation pairs can span inline formatting. Single-language installs need SmartyPants configuration to enable the quote rule.

See the usage reference for field coverage, custom rules and protected text spans.

CLI

With the Kirby CLI installed, fixes can also be applied from the command line:

kirby proofreader:review projects/my-project
kirby proofreader:fix projects/my-project

See docs/usage/index.md for the full flag reference.

Documentation

Full reference for usage, contributions and maintenance lives in documentation.

Changelog

See CHANGELOG.md for version history and changes.

Security

See SECURITY.md for security policies and reporting vulnerabilities.

Contributing

See CONTRIBUTING.md for guidance and expectations.

License

MIT © 2026 Grommas Dietz