I am happy to announce the first release of md2mld, available now from OPAM.
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.
I made it because multiple repositories have their most interesting short examples in their README, and I wanted an easy way to integrate them in the generated documentation without duplicating too much the efforts.
You can see an example of use in the documentation of the tool itself and in the new documentation of ocaml-rpc.