Slipshow (p.slipshow.0.3.0.doc.slipshow.Slipshow)

Sourcemodule Asset : sig ... end

Sourcetype starting_state = int * string

Sourcetype delayed

Sourceval delayed_to_string : delayed -> string

Sourceval string_to_delayed : string -> delayed

val delayed : 
  width:int ->
  height:int ->
  ?math_link:Asset.t ->
  ?css_links:Asset.t list ->
  ?theme:[ `Builtin of Themes.t | `External of Asset.t ] ->
  ?slipshow_js_link:Asset.t ->
  ?read_file:(Fpath.t -> (string option, [ `Msg of string ]) result) ->
  string ->
  delayed

This function is used to delay the decision on the starting state. It allows to run convert server-side (which is useful to get images and so on) but let the previewer decide on the starting state.

Sourceval add_starting_state : delayed -> starting_state option -> string

Source

val convert : 
  width:int ->
  height:int ->
  ?starting_state:starting_state ->
  ?math_link:Asset.t ->
  ?theme:[ `Builtin of Themes.t | `External of Asset.t ] ->
  ?css_links:Asset.t list ->
  ?slipshow_js_link:Asset.t ->
  ?read_file:(Fpath.t -> (string option, [ `Msg of string ]) result) ->
  string ->
  string

Source

val convert_to_md : 
  read_file:(Fpath.t -> (string option, [ `Msg of string ]) result) ->
  string ->
  string