summaryrefslogtreecommitdiff
path: root/vendor/kzykhys/pygments/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/kzykhys/pygments/README.md')
-rw-r--r--vendor/kzykhys/pygments/README.md99
1 files changed, 99 insertions, 0 deletions
diff --git a/vendor/kzykhys/pygments/README.md b/vendor/kzykhys/pygments/README.md
new file mode 100644
index 00000000..64ead7c7
--- /dev/null
+++ b/vendor/kzykhys/pygments/README.md
@@ -0,0 +1,99 @@
+Pygments.php - A Thin Wrapper for the Python Pygments
+=====================================================
+
+[![Latest Stable Version](https://poser.pugx.org/kzykhys/pygments/v/stable.png)](https://packagist.org/packages/kzykhys/pygments)
+[![Build Status](https://travis-ci.org/kzykhys/Pygments.php.png?branch=master)](https://travis-ci.org/kzykhys/Pygments.php)
+[![Coverage Status](https://coveralls.io/repos/kzykhys/Pygments.php/badge.png)](https://coveralls.io/r/kzykhys/Pygments.php)
+
+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`
+
+``` json
+{
+ "require": {
+ "kzykhys/pygments": ">=1.0"
+ }
+}
+```
+
+Usage
+-----
+
+### Highlight the source code
+
+``` php
+<?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
+<?php
+
+use KzykHys\Pygments\Pygments;
+
+$pygments = new Pygments();
+$css = $pygments->getCss('monokai');
+$prefixedCss = $pygments->getCss('default', '.syntax');
+```
+
+### Guesses a lexer name
+
+``` php
+<?php
+
+use KzykHys\Pygments\Pygments;
+
+$pygments = new Pygments();
+$pygments->guessLexer('foo.rb'); // ruby
+```
+
+### Get a list of lexers/formatters/styles
+
+``` php
+<?php
+
+use KzykHys\Pygments\Pygments;
+
+$pygments = new Pygments();
+$pygments->getLexers()
+$pygments->getFormatters();
+$pygments->getStyles();
+```
+
+### Custom `pygmentize` path
+
+``` php
+<?php
+
+use KzykHys\Pygments\Pygments;
+
+$pygments = new Pygments('/path/to/pygmentize');
+```
+
+License
+-------
+
+The MIT License
+
+Author
+------
+
+Kazuyuki Hayashi (@kzykhys) \ No newline at end of file