Module B00_cmark

B00 cmark support.

This models the cmark tool. There's not much to model though.


val tool : B00.Tool.t

tool is the cmark tool.

val cmd : ?⁠validate_utf_8:bool -> ?⁠format:string -> ?⁠args:B00_std.Cmd.t -> B00.Memo.t -> mds:B00_std.Fpath.t list -> o:B00_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.


val to_html : ?⁠generator:string -> ?⁠lang:string -> ?⁠scripts:string list -> ?⁠styles:string list -> ?⁠title:string -> B00.Memo.t -> mds:B00_std.Fpath.t list -> o_frag:B00_std.Fpath.t -> o:B00_std.Fpath.t -> unit

to_html m ~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 and B00_htmlg.El.write_page; for the documentation of optional arguments see the later.