Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.Sign up
Camlhighlight provides syntax highlighting facilities for Ocsigen applications
Fetching latest commit…
Cannot retrieve the latest commit at this time.
|Type||Name||Latest commit message||Commit time|
|Failed to load latest commit information.|
========================================================================= | README for Camlhighlight | | | | http://camlhighlight.forge.ocamlcore.org/ | | | | Dario Teixeira <email@example.com> | ========================================================================= 1. Overview =========== Camlhighlight provides syntax highlighting and pretty-printing facilities for displaying code samples in Ocsigen applications. The library works by interfacing with the library portion of GNU Source-highlight , a popular application supporting the most common programming and markup languages. 2. Dependencies =============== On the OCaml side, Camlhighlight depends on Sexplib, ppx_sexp_conv, and Tyxml [2,3,4]. Tyxml is required because Camlhighlight provides functions that output valid Html values using Tyxml's Html module, whereas Sexplib is used for parsing and to provide serialisation facilities. Camlhighlight requires also GNU Source-highlight, of course. Note that for many Linux distributions you may need to manually download and build the source-code for GNU Source-highlight. There are however some distros that already package the library's runtime and development versions. 3. Building and installing ========================== The build system relies on OASIS. The customary sequence of './configure', 'make', and 'make install' is used to build and install the library. Run 'make doc' to generate the API documentation. You will also need to manually copy the file 'data/sexp.outlang' into GNU Source-highlight's data directory (normally '/usr/share/source-highlight'). 4. License ========== Camlhighlight is distributed under the terms of the GNU GPL version 2. See LICENSE file for full license text. References ==========  https://www.gnu.org/software/src-highlite/  https://github.com/janestreet/sexplib  https://github.com/janestreet/ppx_sexp_conv  https://www.ocsigen.org/tyxml