https://github.com/spatie/commonmark-highlighter
Highlight code blocks with league/commonmark
https://github.com/spatie/commonmark-highlighter
commonmark highlight
Last synced: 20 days ago
JSON representation
Highlight code blocks with league/commonmark
- Host: GitHub
- URL: https://github.com/spatie/commonmark-highlighter
- Owner: spatie
- License: mit
- Created: 2018-11-28T14:18:42.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2022-07-25T17:41:45.000Z (over 2 years ago)
- Last Synced: 2025-03-29T08:06:20.750Z (27 days ago)
- Topics: commonmark, highlight
- Language: PHP
- Homepage: https://spatie.be/open-source
- Size: 56.6 KB
- Stars: 134
- Watchers: 3
- Forks: 10
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
[
](https://supportukrainenow.org)
# Highlight your markdown code blocks with league/commonmark
[](https://github.com/spatie/commonmark-highlighter/releases)
[](https://github.com/spatie/commonmark-highlighter/actions)
[](https://scrutinizer-ci.com/g/spatie/commonmark-highlighter)
[](https://styleci.io/repos/159513310)
[](https://packagist.org/packages/spatie/commonmark-highlighter)
A block renderer for [league/commonmark](https://github.com/thephpleague/commonmark) to highlight code blocks using [scrivo/highlight.php](https://github.com/scrivo/highlight.php).
> highlight.php is a server side code highlighter written in PHP that currently supports 185 languages. It's a port of highlight.js by Ivan Sagalaev that makes full use of the language and style definitions of the original JavaScript project.
The output html is compatible with highlight.js themes, which you can explore on [highlightjs.org](https://highlightjs.org/static/demo/).
What are the benefits of using this package over highlight.js?
- Less JavaScript, which means faster page loads
- No more flash of unstyled code blocks
This project was inspired by [sixlive/parsedown-highlight](https://github.com/sixlive/parsedown-highlight).
## Support us
[
](https://spatie.be/github-ad-click/commonmark-highlighter)
We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
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](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
## Installation
You can install the package via composer:
```bash
composer require spatie/commonmark-highlighter
```
## Usage
Create a custom CommonMark environment, and register the `FencedCodeRenderer` and `IndentedCodeRender` as described in the [league/commonmark documentation](https://commonmark.thephpleague.com/customization/block-rendering/).
```php
use League\CommonMark\Environment\Environment;
use League\CommonMark\Extension\CommonMark\CommonMarkCoreExtension;
use League\CommonMark\Extension\CommonMark\Node\Block\FencedCode;
use League\CommonMark\Extension\CommonMark\Node\Block\IndentedCode;
use League\CommonMark\MarkdownConverter;
use Spatie\CommonMarkHighlighter\FencedCodeRenderer;
use Spatie\CommonMarkHighlighter\IndentedCodeRenderer;
$environment = new Environment();
$environment->addExtension(new CommonMarkCoreExtension());
$environment->addRenderer(FencedCode::class, new FencedCodeRenderer());
$environment->addRenderer(IndentedCode::class, new IndentedCodeRenderer());
$markdownConverter = new MarkdownConverter($environment);
echo $markdownConverter->convertToHtml($markdown);
```
The underlying highlight library recommends specifying a subset of languages for the auto-detection. You can pass an array of languages to any of the renderers.
```php
new FencedCodeRenderer(['html', 'php', 'js']);
new IndentedCodeRenderer(['html', 'php', 'js']);
```
### Highlighting specific lines
Line numbers start at 1.
\`\`\`php - Don't highlight any lines
\`\`\`php{4} - Highlight just line 4
\`\`\`php{4-6} - Highlight the range of lines from 4 to 6 (inclusive)
\`\`\`php{1,5} - Highlight just lines 1 and 5 on their own
\`\`\`php{1-3,5} - Highlight 1 through 3 and then 5 on its own
\`\`\`php{5,7,2-3} - The order of lines don't matter
However, specifying 3-2 will not work.
### Testing
``` bash
composer test
```
### Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](https://github.com/spatie/.github/blob/main/CONTRIBUTING.md) for details.
### Security
If you've found a bug regarding security please mail [[email protected]](mailto:[email protected]) instead of using the issue tracker.
## Postcardware
You're free to use this package, but if it makes it to your production environment we highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using.
Our address is: Spatie, Kruikstraat 22, 2018 Antwerp, Belgium.
We publish all received postcards [on our company website](https://spatie.be/en/opensource/postcards).
## Credits
- [Sebastian De Deyne](https://github.com/sebastiandedeyne)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.