Luminous - a Syntax Highlighter for PHP ======================================= [![Build Status](https://secure.travis-ci.org/markwatkinson/luminous.png)](http://travis-ci.org/markwatkinson/luminous) Luminous is an accurate and style-able syntax highlighter for PHP which supports a bunch of common languages and output to HTML and LaTeX. If you simply want to use Luminous as a library, __please don't clone this repository__. Or if you do, make sure you delete luminous/tests afterwards. Do not expose luminous/tests on a public machine. It is recommended to get a packaged version from the links below. ##Links: + [Luminous PHP syntax highlighter official site](http://luminous.asgaard.co.uk/) - news, latest stable versions, etc + [Online demo](http://luminous.asgaard.co.uk/index.php/demo) + [Documentation and help](http://luminous.asgaard.co.uk/index.php/docs/show/index), read this if you get stuck! + [Supported language list](http://luminous.asgaard.co.uk/assets/luminous/supported.php) + [Luminous on GitHub](https://github.com/markwatkinson/luminous) - please report problems to the issue tracker here Installation ============ Extract your tarball, zip, whatever, into some directory where it's going to be used (i.e. probably your web-server). We'll assume it's called `luminous/' ## Alternatively, Composer: Luminous is also available via Packagist as a Composer package: ```json { "require": { "luminous/luminous": "0.7.*" } } ``` Quick Usage =========== First, if you're going to use caching, which you probably are, create a directory called luminous/cache and give it writable permissions (chmod 777 on most servers -- yours may accept a less permissive value). Then include luminous/luminous.php and away you go! ```php echo luminous::highlight('c', 'printf("hello world\n");'); ``` Useful examples can be found in luminous/examples/. If you have problems, check that luminous/examples/example.php works. ## Autoloading, PSR-0 and stuff. Luminous's entire public interface is in the Luminous class, and this is autoloadable, if you want. ```php register(); echo luminous::highlight('c', 'printf("hello world")'); // works // alternatively, via Composer's autoload: