package yocaml_cmark

  1. Overview
  2. Docs
On This Page
  1. API
package yocaml_cmark
Legend:
Library
Module
Module type
Parameter
Class
Class type

Describing documents using a Markup language is very common in the Blogosphere (rather than describing all the formatting of document content in HTML, using <p>, <strong> and co).

Common Mark is a very popular markup language (did you get the joke, up/down) and, fortunately, OCaml has several one very good libraries for turning Common Mark into HTML. This library is a wrapper around cmarkit, an excellent Common Mark conversion library.

CommonMark is a specification (see RFC7763/RFC7764) of Markdown since 2016. As Markdown, it's a popular markup language and an implementation in OCaml exists: cmarkit.

API

val to_html : strict:bool -> (string, string) Yocaml.Build.t

An arrow that produces an HTML (as a String) from a String in Common Mark.

The strict argument permits to follow only the CommonMark specification. If you attempt to use some extensions (see Cmarkit.Doc.of_string), you should set it to false.

val content_to_html : ?strict:bool -> unit -> ('a * string, 'a * string) Yocaml.Build.t

Since it is pretty common to deal with document and Metadata, which are generally a pair of Metadata and the content of the document, content_to_html is a function that produce an arrow which apply the Common Mark conversion on the second element (the content).

content_to_html () is equivalent of Yocaml.Build.snd to_html.