Download the PHP package grommasdietz/kirby-proofreader without Composer
On this page you can find all versions of the php package grommasdietz/kirby-proofreader. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download grommasdietz/kirby-proofreader
More information about grommasdietz/kirby-proofreader
Files in grommasdietz/kirby-proofreader
Package kirby-proofreader
Short Description Typographic suggestions for Kirby CMS
License MIT
Informations about the package kirby-proofreader
Kirby Proofreader
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
[!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:
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:
The keyed
falseentry disables the built-inquotesrule. The keyedtrademarkarray 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:
See docs/usage/index.md for the full flag reference.
Documentation
Full reference for 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