md2mldversion

Md files into odoc mld files

md2mld converts a Markdown-format file into the mld format used by odoc to render HTML documentation or OCaml libraries. You can use this script to automatically embed a README.md file into API documentation for an OCaml library.

You can use it manually as follows

$ md2mld filename.md > outfile.mld

In dune you can use it to generate an mld file with

(rule (with-stdout-to outfile.mld (run md2mld filename.md)))

You can see the documentation generated from the latest tagged version of this README at mseri.github.io/md2mld/md2mld/index.html.

AuthorMarcello Seri <marcello.seri@gmail.com>
LicenseISC
Published
Homepagehttps://github.com/mseri/md2mld
Issue Trackerhttps://github.com/mseri/md2mld/issues
MaintainerMarcello Seri <marcello.seri@gmail.com>
Dependencies
Source [http] https://github.com/mseri/md2mld/releases/download/0.3.0/md2mld-0.3.0.tbz
md5=3b3833921d67f0fe66da6a03e422abf1
StatisticsInstalled once last month.
Edithttps://github.com/ocaml/opam-repository/tree/master/packages/md2mld/md2mld.0.3.0/opam
No package is dependent