package yocaml_omd

  1. Overview
  2. Docs
Yocaml plugin for using Markdown (via OMD package) as a Markup language

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (9)

Authors

  1. T
    The XHTMLBoy <xhtmlboi@gmail.com>

Maintainers

  1. T
    The XHTMLBoy <xhtmlboi@gmail.com>

Sources

yocaml-2.2.0.tbz
sha256=967db87e63b7da8c3f127df5461eb86d0da9d41ef20e1957beacec9df5ec760c
sha512=930d98d22f19232b498a399e86c88a8ec87d49886eaeb1c296ff48b6d7f1da6c420c53472028410ef83d1914e8268924636353378b5e99bf0e93783769519c9f

doc/yocaml_omd/Yocaml_omd/index.html

Module Yocaml_omdSource

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.

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

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

Sourceval 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.

Sourceval 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).

Sourceval 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.