On This Page
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source
Page
Library
Module
Module type
Parameter
Class
Class type
Source
package hilite
Module HiliteSource
Core
Error type for catching code blocks with languages not supported by the provided collection of textmate grammars.
Methods for looking up grammars, see TmLanguage for the various functions.
The list of supported languages for the default collection of textmate grammers used in src_code_to_html if no tm argument is provided. The grammars for these languages can be found in Grammars.
Source
val src_code_to_pairs :
?escape:bool ->
?lookup_method:tm_lookup_method ->
?tm:TmLanguage.t ->
lang:string ->
string ->
((string * string) list list, [> `Unknown_lang of string ]) resultThe same as src_code_to_html except it only returns (class, content) pairs -- so agnostic to HTML.
Source
val src_code_to_html :
?escape:bool ->
?lookup_method:tm_lookup_method ->
?tm:TmLanguage.t ->
lang:string ->
string ->
(string, error) resultsrc_code_to_html ~lang src will highlight the source code src in language lang and return a string of HTML using span's with keyword classes.
Predefined Grammars
The Grammars module contains some predefined grammars for OCaml-specific languages including OCaml itself and dune, opam and interface files.
On This Page