pygments.rb is a Ruby wrapper for Pygments syntax highlighter.

pygments.rb works by talking over a simple pipe to a long-lived Python child process. This library replaces github/albino, as well as an older version of pygments.rb that used an embedded Python interpreter.

Each Ruby process that runs has its own 'personal Python'; for example, 4 Unicorn workers will have one Python process each. If a Python process dies, a new one will be spawned on the next pygments.rb request.

• Python >= 3.8

• Ruby >= 2.7

Add this line to your application’s Gemfile:

And then execute:

Or install pygments.rb gem globally:

Require pygments.rb module:

Highlight a file:

Optionally, pass encoding and other lexer/formatter options via an :options hash:

pygments.rb uses HTML formatter by default. To use a different formatter, specify it via :formatter parameter:

To generate CSS for HTML formatted code, use the Pygments.css method:

To use a specific pygments style, pass the :style option to the Pygments.css method:

Other Pygments high-level API methods are also available. These methods return arrays detailing all the available lexers, formatters, and styles:

To use a custom pygments installation, specify the path to Pygments.start:

If you’d like logging, set the environmental variable MENTOS_LOG to a file path for your logfile.

You can apply a timeout to pygments.rb calls by specifying number of seconds in MENTOS_TIMEOUT environmental variable or by passing the :timeout argument (takes precedence over MENTOS_TIMEOUT):

After checking out the repo, run bundle install to install dependencies. Then, run bundle exec rake test to run the tests.

Copyright © Ted Nyman, Aman Gupta, Marat Radchenko, 2012-2021. Free use of this software is granted under the terms of the MIT License.

For the full text of the license, see the LICENSE file.