package hilite

  1. Overview
  2. Docs
package hilite
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Hilite_markdownSource

The markdown hilite library depends on Cmarkit. It provides a convenience function transform that maps over markdown documents converting code blocks into HTML with highlighted syntax.

Sourceval transform : ?skip_unknown_languages:bool -> ?lookup_method:Hilite.tm_lookup_method -> ?tm:TmLanguage.t -> Cmarkit.Doc.t -> Cmarkit.Doc.t

transform ?tm md will extract code blocks from md and replace them with HTML code blocks with syntax highlighting spans.

  • parameter lookup_method

    How to lookup grammars using TmLanguage, by default it will use `Name.

  • parameter tm

    If no collection of textmate grammars is provided, then a default OCaml-centric on will be used. See Hilite.Syntax.langs for details.