omd 1.2.5 · OCaml Package

type code_stylist = lang:string -> string -> string

Function that takes a language name and some code and returns that code with style.

val default_language : string Pervasives.ref

default language for code blocks can be set to any name, by default it is the empty string

val html_of_md : 
  ?override:(Omd_representation.element -> string option) ->
  ?pindent:bool ->
  ?nl2br:bool ->
  ?cs:code_stylist ->
  Omd_representation.t ->
  string

html_of_md md returns a string containing the HTML version of md. Note that md uses the internal representation of Markdown.

The optional parameter override allows to override an precise behaviour for a constructor of Omd_representation.element, as in the following example:

let customized_to_html = Omd.html_of_md ~override:(function | Url (href,s,title) -> Some("<a href='" ^ (Omd_utils.htmlentities ~md:true href) ^ "'" ^ (if title <> "" then " title='" ^ (Omd_utils.htmlentities ~md:true title) ^ "'" else "") ^ ">" ^ Omd_backend.html_of_md s ^ " target='_blank'</a>") | _ -> None)

val headers_of_md : 
  Omd_representation.t ->
  (Omd_representation.element * string * string) list

headers_of_md md returns a list of 3-tuples; in each of them the first element is the header (e.g., H1(foo)), the second is the HTML id (as produced by html_of_md), and the third element is the HTML version of foo. The third elements of those 3-tuples exist because if you use html_and_headers_of_md, then you have the guarantee that the HTML version of foo is the same for both the headers and the HTML version of md.

val html_and_headers_of_md : 
  ?override:(Omd_representation.element -> string option) ->
  ?pindent:bool ->
  ?nl2br:bool ->
  ?cs:code_stylist ->
  Omd_representation.t ->
  string * (Omd_representation.element * Omd_utils.StringSet.elt * string) list

html_and_headers_of_md md is the same as (html_of_md md, headers_of_md md) except that it's two times faster. If you need both headers and html, don't use html_of_md and headers_of_md but this function instead.

val escape_markdown_characters : string -> string

escape_markdown_characters s returns a string where markdown-significant characters in s have been backslash-escaped. Note that escape_markdown_characters takes a "raw" string, therefore it doesn't have the whole context in which the string appears, thus the escaping cannot really be minimal. However the implementation tries to minimalise the extra escaping.

val text_of_md : Omd_representation.t -> string

text_of_md md is basically the same as html_of_md md but without the HTML tags in the output.

val markdown_of_md : Omd_representation.t -> string

markdown_of_md md is basically the same as html_of_md md but with the output in Markdown syntax rather than HTML.

val sexpr_of_md : Omd_representation.t -> string

sexpr_of_md md is basically the same as html_of_md md but with the output in s-expressions rather than HTML. This is mainly used for debugging.

package omd