ramsey/pygments

A PHP wrapper for Pygments, the Python syntax highlighter, forked from kzykhys/pygments.

ramsey/pygments

A PHP wrapper for Pygments, the Python syntax highlighter. , _(*1)

, _(*2)

About

ramsey/pygments is a PHP wrapper for Pygments, the Python syntax highlighter, forked from the Pygments.php project., _(*3)

This project adheres to a code of conduct. By participating in this project and its community, you are expected to uphold this code., _(*4)

Installation

Install this package as a dependency using Composer., _(*5)

``` bash composer require ramsey/pygments, <sub>(*6)</sub>

### Requirements

* PHP 8.2 or greater
* Python
* Pygments (`pip install Pygments`)

Python and Pygments versions tested:

| Pygments:   | 2.17 | 2.18 | 2.19 |
|:------------|:----:|:----:|:----:|
| Python 3.11 |  ✔   |  ✔   |  ✔   |
| Python 3.12 |  ✔   |  ✔   |  ✔   |
| Python 3.13 |  ✔   |  ✔   |  ✔   |

> [!NOTE]
> ramsey/pygments will likely work on other versions of Python and Pygments, but
> the versions tested against are limited to keep the GitHub Actions job matrix
> at a reasonable size. If you encounter a version of Python or Pygments that
> does not work, please [open an issue](https://github.com/ramsey/pygments/issues).

## Usage

### Highlight source code

``` php
use Ramsey\Pygments\Pygments;

$pygments = new Pygments();
$html = $pygments->highlight(file_get_contents('index.php'), 'php', 'html');
$console = $pygments->highlight('package main', 'go', 'ansi');

Generate CSS

``` php use Ramsey\Pygments\Pygments;, <sub>(*7)</sub>

$pygments = new Pygments(); $css = $pygments->getCss('monokai'); $prefixedCss = $pygments->getCss('default', '.syntax');, <sub>(*8)</sub>

### Guess lexer name

``` php
use Ramsey\Pygments\Pygments;

$pygments = new Pygments();
$lexer = $pygments->guessLexer('foo.rb'); // ruby

Get a list of lexers/formatters/styles

``` php use Ramsey\Pygments\Pygments;, <sub>(*9)</sub>

$pygments = new Pygments(); $lexers = $pygments->getLexers() $formatters = $pygments->getFormatters(); $styles = $pygments->getStyles();, <sub>(*10)</sub>

### Set a custom `pygmentize` path

``` php
use Ramsey\Pygments\Pygments;

$pygments = new Pygments('/path/to/pygmentize');

Contributing

Contributions are welcome! To contribute, please familiarize yourself with CONTRIBUTING.md., <sub>(*11)</sub>

Coordinated Disclosure

Keeping user information safe and secure is a top priority, and we welcome the contribution of external security researchers. If you believe you've found a security issue in software that is maintained in this repository, please read SECURITY.md for instructions on submitting a vulnerability report., <sub>(*12)</sub>

Copyright and License

The ramsey/pygments library is copyright © Ben Ramsey and licensed for use under the terms of the MIT License (MIT)., <sub>(*13)</sub>

ramsey/pygments is a fork of Pygments.php. The Pygments.php library is copyright © Kazuyuki Hayashi and licensed for use under the terms of the MIT License (MIT)., <sub>(*14)</sub>

Please see LICENSE for more information., <sub>(*15)</sub>