Wallogit.com
2017 © Pedro Peláez
Themeable server-side syntax highlighting for Kirby
, (*1)
This plugin highlights your code snippets server-side - without external dependencies., (*2)
, (*3)
Table of contents - 1. Getting started - 2. Configuration - 3. Styling - 4. Troubleshooting - 5. Credits / License, (*4)
Use one of the following methods to install & use kirby-highlight:, (*5)
If you know your way around Git, you can download this plugin as a submodule:, (*6)
git submodule add https://github.com/S1SYPHOS/kirby-highlight.git site/plugins/kirby-highlight
composer require S1SYPHOS/kirby-highlight:dev-composer
Activate the plugin with the following line in your config.php:, (*7)
c::set('plugin.kirby-highlight', true);
Now proper classes are added to your code snippets, making them 'themeable'. In order to do so, head over to the styling section. If you want to activate kirby-highlight only on specific domains, read about multi-environment setups., (*8)
Change kirby-highlight options to suit your needs:, (*9)
| Option | Type | Default | Description |
|---|---|---|---|
plugin.kirby-highlight.class |
String | 'hljs' |
Sets class of surrounding pre container. |
plugin.kirby-highlight.languages |
Array | ['html', 'php'] |
Defines languages to be auto-detected (currently 176 languages are supported). |
plugin.kirby-highlight.escaping |
Boolean | false |
Enables character escaping (converting < to <, > to >, ..), see htmlspecialchars() docs. |
All highlight.js styles are fully compatible with kirby-highlight. Just include it using the css() helper:, (*10)
<?php echo css('assets/plugins/kirby-highlight/css/zenburn.css') ?>
If in doubt, check the correct spelling of the language in question - doing otherwise breaks kirbytext() (see #2)., (*11)
kirby-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. Are you ready for the next step?, (*12)
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 :), (*13)
Themeable server-side syntax highlighting for Kirby
MIT
Themeable server-side syntax highlighting for Kirby
MIT
Themeable server-side syntax highlighting for Kirby
MIT