Skip to main content

Highlighting ranges in pygments

Project description

Highlight ranges of code in pygments output.

This provides a filter that uses spor anchors to determine which ranges of code to highlight in the pygmentized output. You specify the ranges by creating anchors with metadata where the key “highlight” is true, e.g.:

{"highlight": true}

Quick start

First, install highlight-ranges. See the “Installation” section for details.

Create a directory somewhere and create a file named example.py with the following contents:

def func(x):
    y = x * 4
    return y

Now initialize a spor repository and add an anchor that will highlight the second line in the file:

spor init
spor add example.py 17 9 5

Finally, use the highlight-ranges filter to generate the pygmentized HTML of the code:

pygmentize -l python3 -f html -O full -F highlight-ranges:file=example.py example.py > example.html

If you open example.html in a browser, you should see the second line in the code emphasized.

Installation

You can install from PyPI with pip::

pip install highlight-ranges

Or you can install from source:

pip install .

Styling

The filter marks highlighted ranges of code with the Generic.Emph type. From a CSS point of view, this means you can style the highlights via the ge class.

Filter options

file
The file being pygmentized.

Project details


Release history Release notifications

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
highlight_ranges-1.0.0-py3-none-any.whl (5.6 kB) Copy SHA256 hash SHA256 Wheel py3
highlight_ranges-1.0.0.tar.gz (3.5 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page