Code highlighting with Shiki in PHP
Shiki is a beautiful syntax highlighter powered by the same language engine that many code editors use. This package allows you to use Shiki from PHP.
\Spatie\ShikiPhp\Shiki::highlight(
code: '',
language: 'php',
theme: 'github-light',
);
This package also ships with the following extra languages, on top of the 100+ that Shiki supports out of the box:
- Antlers
- Blade
Usage in Laravel and league/commonmark
Laravel users can easily use Shiki via our spatie/laravel-markdown package.
If you need a league/commonmark extension to highlight code, head over to spatie/commonmark-shiki-highlighter.
Support us
We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.
Installation
You can install the package via composer:
composer require spatie/shiki-php
In your project, you should have the JavaScript package shiki installed. You can install it via npm...
npm install shiki
... or Yarn.
yarn add shiki
Make sure you have installed Node 10 or higher.
Usage
Here's an example where we are going to highlight some PHP code.
use Spatie\ShikiPhp\Shiki;
Shiki::highlight(
code: '',
language: 'php',
theme: 'github-light',
);
The output is this chunk of HTML which will render beautifully in the browser:
<?php echo "Hello World"; ?>
">
class="shiki" style="background-color: #2e3440ff">class="line">"color: #81A1C1"><?"color: #D8DEE9FF">php "color: #81A1C1">echo"color: #D8DEE9FF"> "color: #ECEFF4">""color: #A3BE8C">Hello World"color: #ECEFF4">""color: #81A1C1">;"color: #D8DEE9FF"> "color: #81A1C1">?>
Marking lines as highlighted, added, deleted or focus
Shiki-php allows you to mark certain lines as highlighted, added, deleted and focus. To do this, you can pass in the necessary lines to the highlight method:
use Spatie\ShikiPhp\Shiki;
// Highlighting lines 1 and 4,5,6
Shiki::highlight(
code: $code,
language: 'php',
highlightLines: [1, '4-6'],
);
// Marking line 1 as added
Shiki::highlight(
code: $code,
language: 'php',
addLines: [1],
);
// Marking line 1 as deleted
Shiki::highlight(
code: $code,
language: 'php',
deleteLines: [1],
);
// Marking line 1 as focus
Shiki::highlight(
code: $code,
language: 'php',
focusLines: [1],
);
You can then target these classes in your own CSS to color these lines how you want.
Determining available languages
To get an array with all languages that Shiki supports, call getAvailableLanguages
$shiki = new \Spatie\ShikiPhp\Shiki();
$shiki->getAvailableLanguages(); // returns an array
$shiki->languageIsAvailable('php'); // returns true
$shiki->languageIsAvailable('non-existing-language'); // returns false
Determining available themes
To get an array with all themes that Shiki supports, call getAvailableThemes
$shiki = new \Spatie\ShikiPhp\Shiki();
$shiki->getAvailableThemes(); // returns an array
$shiki->themeIsAvailable('github-light'); // returns true
$shiki->themeIsAvailable('non-existing-theme'); // returns false
Using a custom theme
Shiki supports any VSCode themes.
You can load a theme simply by passing an absolute path as the theme parameter.
use Spatie\ShikiPhp\Shiki;
Shiki::highlight(
code: '',
language: 'php',
theme: __DIR__ . '/your-path-to/themes/some-theme.json',
);
Testing
You can run all the tests with this command:
composer test
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
The Blade syntax highlighting source is taken from this repo.
The Antlers syntax highlighting source is taken from this repo.
Alternatives
If you don't want to install and handle Shiki yourself, take a look at Torchlight, which can highlight your code with minimal setup.
License
The MIT License (MIT). Please see License File for more information.
4 Oct 16, 2021
5 Nov 14, 2021
12 Apr 25, 2022
15 Dec 17, 2021
16 Nov 11, 2022
464 Dec 28, 2022
2 Oct 29, 2022
26 Jul 4, 2022
32 Dec 29, 2022
55 Aug 27, 2022
4 Jan 3, 2022
41 Nov 19, 2022
0 Feb 22, 2022
1.7k Dec 27, 2022
4 Apr 20, 2022
1.2k Oct 29, 2022
1 Jan 3, 2022