md2mld

Little cli tool to convert md files into mld files
README

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.

Usage

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.

Known issues

  • Until the new odoc fixing #141 is released, the minimal header allowed in the md file will be the level 3 one ###.
    You can work around this by using the -min-header 3 flag during the invocation of md2mld.

  • If you see an error like '{0': heading level should be lower than top heading level '0', this is because in ocamldoc the first header must have a level higher than all other headings in the page.
    You can safely ignore it or increase the level of the subsequent headings to get rid of it.

Install
Sources
md2mld-0.5.1.tbz
sha256=c8e7066b28ab70a1dc687a6939a4c6934aef9734c058659b0534168250dee503
sha512=b5c58b8dbd29b5f983be36970d8344b9f6d5d3e8a7db4d7cae6a080a0748dad684f2c8f015c5b9d8bf2993ace21a7c2e23f187e08448ab27e1133dc1139bb565
Dependencies
omd
>= "2.0.0~alpha2"
dune
>= "2.0"
Reverse Dependencies
rpc
>= "6.1.0" & < "7.1.0" | >= "8.1.1"