kzykhys/pygments

There is no license information available for the latest version (v1.0.0) of this package.

A Thin Wrapper for the Python Pygments

v1.0.0 2013-12-18 15:22 UTC

README

Latest Stable Version Build Status Coverage Status SensioLabsInsight

A PHP wrapper for the Python Pygments syntax highlighter

Requirements

  • PHP5.3+
  • Python 2.4+
  • Pygments (sudo easy_install Pygments)

Installation

Create or update your composer.json and run composer update

{
    "require": {
        "kzykhys/pygments": ">=1.0"
    }
}

Usage

Highlight the source code

<?php

use KzykHys\Pygments\Pygments;

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

Generate a CSS

<?php

use KzykHys\Pygments\Pygments;

$pygments = new Pygments();
$css = $pygments->getCss('monokai');
$prefixedCss = $pygments->getCss('default', '.syntax');

Guesses a lexer name

<?php

use KzykHys\Pygments\Pygments;

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

Get a list of lexers/formatters/styles

<?php

use KzykHys\Pygments\Pygments;

$pygments = new Pygments();
$pygments->getLexers()
$pygments->getFormatters();
$pygments->getStyles();

Custom pygmentize path

<?php

use KzykHys\Pygments\Pygments;

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

License

The MIT License

Author

Kazuyuki Hayashi (@kzykhys)