Module `Omd`Source

A markdown parser in OCaml

The following types define the AST representing Omd's document model.

Sourcetype 'attr inline =

Sourceand 'attr link = {

}

Sourcetype list_type =

Sourcetype list_spacing =

Sourcetype cell_alignment =

Sourcetype !'attr def_elt = {

}

Sourcetype !'attr block =

| Paragraph of 'attr * 'attr Omd__.Ast_inline.inline
| List of 'attr * Omd__.Ast_block.List_types.list_type * Omd__.Ast_block.List_types.list_spacing * 'attr block list list
| Blockquote of 'attr * 'attr block list
| Thematic_break of 'attr
| Heading of 'attr * int * 'attr Omd__.Ast_inline.inline
| Code_block of 'attr * string * string
| Html_block of 'attr * string
| Definition_list of 'attr * 'attr def_elt list
| Table of 'attr * ('attr Omd__.Ast_inline.inline * Omd__.Ast_block.Table_alignments.cell_alignment) list * 'attr Omd__.Ast_inline.inline list list
(*
A table is represented by a header row, which is a list of pairs of header cells and alignments, and a list of rows
*)

Sourcetype attributes = (string * string) list

Sourcetype doc = attributes block list

Sourcemodule Ctor : sig ... end

Functions to help constructing the elements of a doc.

val headers : 
  ?remove_links:bool ->
  'attr block list ->
  ('attr * int * 'attr inline) list

Sourceval toc : ?start:int list -> ?depth:int -> doc -> doc

Sourceval escape_html_entities : string -> string

Perform escaping of HTML entities. Turns: '"' into """, '&' into "&", '<' in "<" and '>' into ">"

Sourceval of_channel : in_channel -> doc

Sourceval of_string : string -> doc

Sourceval to_html : ?auto_identifiers:bool -> doc -> string

Sourceval to_sexp : doc -> string