higlo
  1. Overview
  2. Docs
On This Page
  1. Higlo
    1. API
package higlo
Legend:
Library
Module
Module type
Parameter
Class
Class type

higlo 0.9

Higlo

Higlo is an OCaml library for syntax highlighting. Higlo could mean Highlighting in Ocaml.

The purpose of Higlo is not to provide syntax highlighting for every language, nor target every format (HTML, LaTeX, ...). It provides a simple way to support additional languages and develop the generator for the output format you need.

By now, only some input languages are supported (OCaml, XML, JSON and Graphviz/dot), and it only generates Xtmpl.Rewrite.tree to highlight code in XML. Developing support for additional input languages is just a matter of writing a Sedlex lexer. Supporting another output format only requires mapping values of type Higlo.Lang.token.

See the OCaml lexer for an example of Higlo Sedlex lexer.

API

The API consists in these modules: Higlo.Lang, Higlo.Printers.