package yocaml_markdown

  1. Overview
  2. Docs
On This Page
  1. API
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).

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

API

val to_html : (string, string) Yocaml.Build.t

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

val content_to_html : 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 Markdown conversion on the second element (the content).

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

OCaml

Innovation. Community. Security.