package yocaml_omd

You can search for identifiers within the package.

in-package search v0.2.0

yocaml_omd
- Yocaml_omd

Legend:
Library
Module
Module type
Parameter
Class
Class type

Allows you to use OMD(https://ocaml.org/p/omd/latest) to use Markdown(https://en.wikipedia.org/wiki/Markdown) as a markup language. Historically, the package was named yocaml_markdown but was renamed yocaml_omd to support multiple Markdown parsers.

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

to_html is an arrow that uses OMD to convert Markdown to HTML.

val to_html_with_toc : (string, string option * string) Yocaml.Task.t

to_html_with_toc is an arrow that uses OMD to convert Markdown to HTML, it returns a pair where the first argument is an HTML representation of the table of contents, and the second one is the document.

val content_to_html : unit -> ('a * string, 'a * string) Yocaml.Task.t

content_to_html is an arrow that uses OMD to convert the content of a file from Markdown to HTML. (Since we usually read a file with metadata as a pair of metadata and string).

val content_to_html_with_toc : 
  ('a -> string option -> 'b) ->
  ('a * string, 'b * string) Yocaml.Task.t

content_to_html_with_toc f is an arrow that uses OMD to convert the content of a file from Markdown to HTML. (Since we usually read a file with metadata as a pair of metadata and string). The arrow takes also a f that can merge the metadata with the computed table of contents.