package markdown

  1. Overview
  2. Docs
package markdown
Legend:
Library
Module
Module type
Parameter
Class
Class type
type ref = {
  1. src : string;
  2. desc : string;
}
type paragraph =
  1. | Normal of par_text
  2. | Pre of string * string option
  3. | Heading of int * par_text
  4. | Quote of paragraph list
  5. | Ulist of paragraph list * paragraph list list
  6. | Olist of paragraph list * paragraph list list
and par_text = text list
and text =
  1. | Text of string
  2. | Emph of string
  3. | Bold of string
  4. | Struck of par_text
  5. | Code of string
  6. | Anchor of string
  7. | Image of img_ref
and href = {
  1. href_target : string;
  2. href_desc : string;
}
and img_ref = {
  1. img_src : string;
  2. img_alt : string;
}
and par_list = paragraph list
type parse_state = {
  1. max : int;
  2. current : Stdlib.Buffer.t;
  3. fragments : text list;
}
val indentation : ?ts:int -> string -> int
val unescape : string -> string
val unescape_slice : string -> first:int -> last:int -> string
val snd_is : string -> char -> bool
val snd_is_space : string -> bool
val collect : ('a -> 'b option) -> 'c -> 'd list
val push_remainder : ?first:int -> int -> string -> (int * string * bool) BatEnum.t -> unit
val adds : Stdlib.Buffer.t -> string -> unit
val addc : Stdlib.Buffer.t -> char -> unit
val new_fragment : unit -> Stdlib.Buffer.t
val push_current : parse_state -> text list
val read_paragraph : ?skip_blank:bool -> int -> (int * string * bool) BatEnum.t -> paragraph option
val skip_blank_line : (int * string * bool) BatEnum.t -> unit
val read_nonempty : int -> (int * string * bool) BatEnum.t -> string -> paragraph option
val read_heading : string -> paragraph option
val read_ul : int -> char -> (int * string * bool) BatEnum.t -> paragraph option
val read_ol : int -> (int * string * bool) BatEnum.t -> paragraph option
val read_list : (paragraph list -> paragraph list list -> paragraph) -> (string -> bool) -> int -> (int * string * bool) BatEnum.t -> paragraph option
val read_pre : string -> (int * string * bool) BatEnum.t -> paragraph option
val read_quote : int -> (int * string * bool) BatEnum.t -> paragraph option
val read_normal : (int * string * bool) BatEnum.t -> paragraph option
val scan : string -> parse_state -> int -> par_text
val delimited : (first:int -> last:int -> text) -> string -> string -> parse_state -> int -> par_text
val scan_past : delim:string -> string -> max:int -> int -> int option
val matches_at : string -> max:int -> int -> string -> bool
val parse_enum : string BatEnum.t -> paragraph list
val parse_lines : string list -> paragraph list
val parse_text : string -> paragraph list