medienbaecker / kirby-editoria11y

1.3.1 2026-10-13 20:13 UTC

Requires

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

GPL-2.0-only

• Thomas Günther

Published on Packagist.org on 2026-10-13 20:13 UTC

README

Make accessibility issues visible to editors in the Kirby Panel, powered by Editoria11y.

Installation

composer require medienbaecker/kirby-editoria11y

Or download this repository and put it in site/plugins/kirby-editoria11y.

Requires Kirby 5. No configuration needed. The checker is automatically set to the logged-in account's Panel language.

How it works

The preview button automatically shows the number of alerts for the current page. Opening a page in the Panel checks it in the background:

In the page preview, editors see what to fix. Errors stay until they're fixed. Warnings can be marked OK, which hides them for all editors.

In the Accessibility view you can check all pages at once:

editoria11y-scan-dark.mp4

Storage

Check results and warnings marked OK are stored in an SQLite database, per page and language: site/logs/editoria11y/editoria11y.sqlite (in Kirby's logs folder). Nothing is written to your content files. When a page is deleted, its entries are deleted too.

Options

'medienbaecker.editoria11y' => [
	// Pages in the overview (default: all pages)
	'pages' => fn () => collection('sitemap'),

	// Passed to Editoria11y, e.g. to ignore alerts caused by templates
	'config' => [
		'ignoreByTest' => [
			'QA_FAKE_HEADING' => ':not(.rich-text *)',
		],
	],

	// Path to the SQLite database
	'database' => fn () => kirby()->root('logs') . '/editoria11y/editoria11y.sqlite',
],

The pages option takes a function that returns a pages collection. I tend to have a sitemap collection in my sites that I also use for, well, the sitemap.

License

GPL-2.0, because it bundles Editoria11y 3.0.2 (source), which is GPL-2.0 and includes parts of Sa11y under the MIT License. Copyright (c) 2026 Thomas Günther.