This plugin highlights your code snippets server-side - without external dependencies.
- Code highlighting for everyone - no javascript needed
- Comprehensive: supports 185 languages
- Customisable: 89 different styles included
Table of contents
Use one of the following methods to install & use kirby3-highlight
:
If you know your way around Git, you can download this plugin as a submodule:
git submodule add https://github.com/S1SYPHOS/kirby3-highlight.git site/plugins/kirby-highlight
composer require s1syphos/kirby3-highlight
Now proper classes are added to your code snippets, making them 'themeable'. In order to do so, head over to the styling section.
Change kirby-highlight
options to suit your needs:
Option | Type | Default | Description |
---|---|---|---|
s1syphos.highlight.class |
String | 'hljs' |
Adds one or more classes to the preceding pre element. |
s1syphos.highlight.languages |
Array | ['html', 'php'] |
Defines languages to be auto-detected (currently 176 languages are supported). |
s1syphos.highlight.escaping |
Boolean | false |
Enables character escaping (converting < to < , > to > , ..), see htmlspecialchars() docs. |
All highlight.js
styles are fully compatible with kirby3-highlight
. Just include it using the css()
helper:
<?= css('/media/plugins/s1syphos/highlight/css/zenburn.css') ?>
If in doubt, check the correct spelling of the language in question - doing otherwise might break kirbytext()
.
kirby3-highlight
is based on Geert Bergman's highlight.php
library (a PHP port of highlight.js). It is licensed under the MIT License, but using Kirby in production requires you to buy a license.
I'd like to thank everybody that's making great software - you people are awesome. Also I'm always thankful for feedback and bug reports :)