skylighting: syntax highlighting library

This is a package candidate release! Here you can preview how this package release will appear once published to the main package index (which can be accomplished via the 'maintain' link below). Please note that once a package has been published to the main package index it cannot be undone! Please consult the package uploading documentation for more information.

[maintain] [Publish]

Skylighting is a syntax highlighting library with support for over one hundred languages. It derives its tokenizers from XML syntax definitions used by KDE's KSyntaxHighlighting framework, so any syntax supported by that framework can be added. An optional command-line program is provided. Skylighting is intended to be the successor to highlighting-kate. This package provides generated syntax modules based on the KDE XML definitions provided by the skylighting-core package. As a result this package is licensed under the GPL.

[Skip to Readme]


Versions,, 0.1.1,,,,,, 0.2, 0.3, 0.3.1, 0.3.2, 0.3.3,, 0.3.4,, 0.3.5, 0.4, 0.4.1, 0.4.2, 0.4.3,,, 0.4.4,, 0.5,, 0.5.1, 0.6, 0.7,,, 0.7.1, 0.7.2, 0.7.3, 0.7.4, 0.7.5, 0.7.6, 0.7.7, 0.8, 0.8.1,,,, 0.8.2,,,, 0.8.3,,,, 0.8.4, 0.8.5, 0.9, 0.10,,,, 0.10.1, 0.10.2, 0.10.3, 0.10.4,, 0.10.5,,, 0.11, 0.12, 0.12.1, 0.12.2, 0.12.3,, 0.13, 0.13.1,,, 0.13.2,, 0.13.3, 0.13.4,, 0.14, 0.14.1,,, 0.14.2
Change log
Dependencies aeson (>=1.0), ansi-terminal (>=0.7), attoparsec, base (>=4.8 && <5.0), base64-bytestring, binary, blaze-html (>=0.5), bytestring, case-insensitive, colour (>=2.0), containers, directory, filepath, hxt, mtl, pretty-show, regex-pcre, regex-pcre-builtin, safe, skylighting, skylighting-core (>= && <0.8.2), text, utf8-string [details]
License GPL-2.0-only
Copyright (C) 2016 John MacFarlane
Author John MacFarlane
Category Text
Home page
Source repo head: git clone
Uploaded by JohnMacFarlane at 2019-06-13T17:20:24Z


[Index] [Quick Jump]


Automatic Flags

Use regex-pcre instead of regex-pcre-builtin


Whether to build the skylighting program


Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info


Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Readme for skylighting-

[back to package description]


Package License Status
skylighting license skylighting build status
skylighting-core license skylighting-core build status

A Haskell syntax highlighting library with tokenizers derived from KDE XML syntax highlighting descriptions.

A command-line highlighter program, skylighting, is also provided.

This project is divided up into two packages:


This library is the successor to highlighting-kate, which had some problems that were difficult to resolve given its architecture.

In highlighting-kate, the XML syntax descriptions were converted into individual parsec parsers, which were then compiled. This made it difficult to handle IncludeRules properly without circular imports. There was also no way to load a syntax description dynamically.

Skylighting, by contrast, parses the XML syntax descriptions into Haskell data structures, which are then interpreted by a "tokenize" function. IncludeRules can now be handled properly, and users can add new syntax descriptions dynamically. It is also now possible to convert .theme files directly into styles.

Skylighting is also faster than highlighting-kate, by a factor of 3 in some cases.


To install the latest release from Hackage, do

stack install skylighting


cabal install skylighting

If you want the command-line tool, set the executable flag using --flag "skylighting:executable" in stack or -fexecutable in cabal.

The release tarball for the skylighting package includes generated files not present in this repository. Building from this repository is a two-step process. In the first step we build the skylighting-core package, which provides a program, skylighting-extract, which reads XML syntax highlighting definitions from the xml directory and writes Haskell source files. In the second we actually build the skylighting package.

Using cabal:

cd skylighting-core
cabal install -fexecutable
cd ../skylighting
skylighting-extract ../skylighting-core/xml/*.xml
cabal install -fexecutable

Using stack:

stack install --flag skylighting-core:executable skylighting-core
cd skylighting
skylighting-extract ../skylighting-core/xml/*.xml
cd ..
stack install --flag skylighting:executable

Command-line tool

A command-line executable, skylighting, is installed if the executable cabal flag is set in building.

For help, skylighting --help.

Adding new syntaxes

To compile with additional syntaxes, simply add the syntax definition (XML) file to the xml directory of the skylighting-core package and repeat the bootstrap build described above.

Note that both the library and the executable can dynamically load syntax definitions, so you may not need to compile them in. If you prefer this approach, you can use the skylighting-core package directly which provides the XML files without the generated code produced by the bootstrap process described above.


The skylighting package is licensed under the GPL because some of the XML syntax descriptions from which its tokenizers are generated are GPL-licensed. However, the skylighting-core package, which provides the core types and functions of this project is licensed under the BSD3 license and bundles the GPL-licensed XML files separately.


Kate syntax highlighting documentation:

Kate highlighting definitions: