Module B0_cmark

cmark support.

Cmark

val tool : B0_memo.Tool.t

tool is the cmark tool.

val cmd : ?validate_utf_8:bool -> ?format:string -> B0_memo.t -> opts:B0_std.Cmd.t -> mds:B0_std.Fpath.t list -> o:B0_std.Fpath.t -> unit

cmd m ~format ~validate_utf_8 ~args ~mds ~o writes to file o the result of processing the CommonMark files mds.

  • format is the output format. It defaults to "html" which outputs a fragment not a full page page (this the --to option).
  • validate_utf_8 is the --validate-utf8 option it defaults to true.
  • args are additional command line arguments you may want to pass to cmark.

Convenience

val to_html : ?generator:string -> ?lang:string -> ?scripts:string list -> ?styles:string list -> ?title:string -> B0_memo.t -> opts:B0_std.Cmd.t -> mds:B0_std.Fpath.t list -> o_frag:B0_std.Fpath.t -> o:B0_std.Fpath.t -> unit

to_html m ~opts ~mds ~o_frag o compiles the concatenation of mds to an HTML fragment o_frag and then to an HTML page o by invoking cmd with opts and B0_web_page.write; for the documentation of optional arguments see the later.