grommasdietz / kirby-proofreader
Typographic suggestions for Kirby CMS
Package info
github.com/grommasdietz/kirby-proofreader
Type:kirby-plugin
pkg:composer/grommasdietz/kirby-proofreader
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
Suggests
None
Provides
None
Conflicts
None
Replaces
None
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
See usage for rule configuration, language-aware corrections, protected spans and CLI review/fix commands.
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
