PHPackages                             s1syphos/kirby3-highlight - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility &amp; Helpers](/categories/utility)
4. /
5. s1syphos/kirby3-highlight

AbandonedArchivedKirby-plugin[Utility &amp; Helpers](/categories/utility)

s1syphos/kirby3-highlight
=========================

Themeable server-side syntax highlighting for Kirby v3

1.0.0(7y ago)743MITCSS

Since Mar 18Pushed 7y ago1 watchersCompare

[ Source](https://github.com/S1SYPHOS/kirby3-highlight)[ Packagist](https://packagist.org/packages/s1syphos/kirby3-highlight)[ RSS](/packages/s1syphos-kirby3-highlight/feed)WikiDiscussions master Synced yesterday

READMEChangelog (1)Dependencies (3)Versions (2)Used By (0)

Kirby3 Highlight
================

[](#kirby3-highlight)

[![Release](https://camo.githubusercontent.com/261f4e909387f53f9c150254108d56e60bdb661974b2dcfe18288da8157088e9/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f72656c656173652f5331535950484f532f6b69726279332d686967686c696768742e737667)](https://github.com/S1SYPHOS/kirby3-highlight/releases) [![License](https://camo.githubusercontent.com/8a5a44602ccaa23740c69393be6e288e6ce59261b95875658c04d7664bcd1037/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f5331535950484f532f6b69726279332d686967686c696768742e737667)](https://github.com/S1SYPHOS/kirby3-highlight/blob/master/LICENSE) [![Issues](https://camo.githubusercontent.com/7eb3104af3bd84c5916c6e9ffe9bf7779273bb5f5aae10ebce99e760ae570235/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6973737565732f5331535950484f532f6b69726279332d686967686c696768742e737667)](https://github.com/S1SYPHOS/kirby3-highlight/issues)

This plugin highlights your code snippets server-side - without external dependencies.

- Code highlighting for everyone - no javascript needed
- Comprehensive: supports [185 languages](https://github.com/scrivo/highlight.php/tree/master/Highlight/languages)
- Customisable: [89 different styles](https://github.com/S1SYPHOS/kirby3-highlight/tree/master/assets/css) included

[![screenshot of the kirby3-highlight plugin](screenshot.gif)](screenshot.gif)

**Table of contents**

- [1. Getting started](#getting-started)
- [2. Configuration](#configuration)
- [3. Styling](#styling)
- [4. Troubleshooting](#troubleshooting)
- [5. Credits / License](#credits--license)

Getting started
---------------

[](#getting-started)

Use one of the following methods to install &amp; use `kirby3-highlight`:

### Git submodule

[](#git-submodule)

If you know your way around Git, you can download this plugin as a [submodule](https://github.com/blog/2104-working-with-submodules):

```
git submodule add https://github.com/S1SYPHOS/kirby3-highlight.git site/plugins/kirby-highlight

```

### Composer

[](#composer)

```
composer require s1syphos/kirby3-highlight

```

### Clone or download

[](#clone-or-download)

1. [Clone](https://github.com/S1SYPHOS/kirby3-highlight.git) or [download](https://github.com/S1SYPHOS/kirby3-highlight/archive/master.zip) this repository.
2. Unzip / Move the folder to `site/plugins`.

Now proper classes are added to your code snippets, making them 'themeable'. In order to do so, head over to the [styling](#styling) section.

Configuration
-------------

[](#configuration)

Change `kirby-highlight` options to suit your needs:

OptionTypeDefaultDescription`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 `&gt;`, ..), see `htmlspecialchars()` [docs](http://php.net/manual/en/function.htmlspecialchars.php).Styling
-------

[](#styling)

All `highlight.js` styles are fully compatible with `kirby3-highlight`. Just include it using the `css()` [helper](https://getkirby.com/docs/cheatsheet/helpers/css):

```

```

Troubleshooting
---------------

[](#troubleshooting)

If in doubt, check the [correct spelling](https://github.com/S1SYPHOS/kirby3-highlight/tree/master/vendor/scrivo/highlight.php/Highlight/languages) of the language in question - doing otherwise might break `kirbytext()`.

Credits / License
-----------------

[](#credits--license)

`kirby3-highlight` is based on Geert Bergman's [`highlight.php`](https://github.com/scrivo/highlight.php) library (a PHP port of [highlight.js](https://highlightjs.org)). It is licensed under the [MIT License](LICENSE), but **using Kirby in production** requires you to [buy a license](https://getkirby.com/buy).

Special Thanks
--------------

[](#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 :)

###  Health Score

28

—

LowBetter than 54% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity13

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity59

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

2612d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/5933072731cd628e1ef2bdc59bc81da16dac859145a3be2dc5c83aab9095179b?d=identicon)[S1SYPHOS](/maintainers/S1SYPHOS)

---

Top Contributors

[![S1SYPHOS](https://avatars.githubusercontent.com/u/12161504?v=4)](https://github.com/S1SYPHOS "S1SYPHOS (2 commits)")

###  Code Quality

Code StylePHP CS Fixer

### Embed Badge

![Health badge](/badges/s1syphos-kirby3-highlight/health.svg)

```
[![Health](https://phpackages.com/badges/s1syphos-kirby3-highlight/health.svg)](https://phpackages.com/packages/s1syphos-kirby3-highlight)
```

###  Alternatives

[distantnative/retour-for-kirby

Manage redirects and track 404s right from the Kirby CMS Panel

14689.4k1](/packages/distantnative-retour-for-kirby)[spatie/commonmark-highlighter

Highlight your markdown code blocks with league/commonmark

138400.5k19](/packages/spatie-commonmark-highlighter)[mzur/kirby-uniform

A versatile Kirby plugin to handle web form actions.

26068.3k13](/packages/mzur-kirby-uniform)[arnoson/kirby-vite

Vite helper for Kirby CMS

9759.2k3](/packages/arnoson-kirby-vite)[sylvainjule/locator

A map &amp; geolocation field, built on top of open-source services / Mapbox

11237.3k1](/packages/sylvainjule-locator)[tobimori/kirby-seo

The default choice for SEO on Kirby: Implement technical SEO &amp; Meta best practices with ease and provide an easy-to-use editor experience

10039.7k1](/packages/tobimori-kirby-seo)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
