Download the PHP package s1syphos/kirby-highlight without Composer
On this page you can find all versions of the php package s1syphos/kirby-highlight. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download s1syphos/kirby-highlight
More information about s1syphos/kirby-highlight
Files in s1syphos/kirby-highlight
Package kirby-highlight
Short Description Themeable server-side syntax highlighting for Kirby
License MIT
Informations about the package kirby-highlight
Kirby Highlight
This plugin highlights your code snippets server-side - without external dependencies.
- Code highlighting for everyone - no javascript needed
- Comprehensive: supports 176 languages
- Customisable: 79 different styles included
Table of contents
- 1. Getting started
- 2. Configuration
- 3. Styling
- 4. Troubleshooting
- 5. Credits / License
Getting started
Use one of the following methods to install & use kirby-highlight
:
Git submodule
If you know your way around Git, you can download this plugin as a submodule:
Composer
Clone or download
Activate the plugin
Activate the plugin with the following line in your config.php
:
Now proper classes are added to your code snippets, making them 'themeable'. In order to do so, head over to the multi-environment setups.
Configuration
Change kirby-highlight
options to suit your needs:
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. |
Styling
All highlight.js
styles are fully compatible with kirby-highlight
. Just include it using the css()
helper:
Troubleshooting
If in doubt, check the correct spelling of the language in question - doing otherwise breaks kirbytext()
(see #2).
Credits / License
kirby-highlight
is based on Geert Bergman's highlight.php
library (a PHP port of highlight.js). It is licensed under the next step?
Special Thanks
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 :)