lindemannrock / craft-code-highlighter
Lightweight syntax highlighting for Craft CMS using Prism.js
Package info
github.com/LindemannRock/craft-code-highlighter
Type:craft-plugin
pkg:composer/lindemannrock/craft-code-highlighter
Requires
- php: ^8.2
- craftcms/cms: ^5.0.0
- lindemannrock/craft-plugin-base: ^5.0
Requires (Dev)
- craftcms/ecs: dev-main
- craftcms/phpstan: dev-main
README
Code Highlighter for Craft CMS
Professional syntax highlighting for Craft CMS using Prism.js. Perfect for documentation sites, technical blogs, and any site displaying code.
License
This is a commercial plugin licensed under the Craft License. It will be available on the Craft Plugin Store soon. See LICENSE.md for details.
⚠️ Pre-Release
This plugin is in active development and not yet available on the Craft Plugin Store. Features and APIs may change before the initial public release.
Features
- Code field with a real editor — live syntax highlighting in the Control Panel, with line numbers, tab/indent handling, undo/redo, and an optional in-editor language switcher
- ~177 languages — Prism's full language set, bundled and loaded on demand (with dependency resolution); choose which appear in field dropdowns
- 25 themes — from classic Prism themes to Dracula, Nord, One Dark, VS Code Dark+ and more; set one plugin-wide or override it per page
- Highlighting extras — line numbers, copy-to-clipboard button, matching-brace highlighting, and inline CSS colour swatches
- Twig API — print a Code field, re-render with overrides, or highlight any string with the
|highlight/|prismfilters - Integration trait — let other plugins highlight code with graceful fallback when this plugin isn't installed
- Bundled & offline — Prism core, all languages, and all themes are served from the plugin's own assets (no CDN)
- CSS-variable theming — restyle the wrapper and copy button without overriding selectors
- 12 languages — Control-Panel UI translated out of the box
Requirements
- Craft CMS 5.0 or greater
- PHP 8.2 or greater
Installation
Via Composer
composer require lindemannrock/craft-code-highlighter
php craft plugin/install code-highlighter
Using DDEV
ddev composer require lindemannrock/craft-code-highlighter
ddev craft plugin/install code-highlighter
Documentation
Full documentation is available in the docs folder.
Support
- Issues: GitHub Issues
- Email: support@lindemannrock.com
Credits
- Uses Prism.js for syntax highlighting (MIT License)
- Uses bililiteRange for contenteditable handling (MIT License)
License
This plugin is licensed under the Craft License. See LICENSE.md for details.
Developed by LindemannRock
