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.
Author | Marcello Seri <marcello.seri@gmail.com> |
---|---|
License | ISC |
Published | |
Homepage | https://github.com/mseri/md2mld |
Issue Tracker | https://github.com/mseri/md2mld/issues |
Maintainer | Marcello Seri <marcello.seri@gmail.com> |
Dependencies |
|
Source [http] | https://github.com/mseri/md2mld/releases/download/0.3.0/md2mld-0.3.0.tbz sha256=6e3706c87716ba090cbc9f43b01c468387453d77f9e45321a6a51d19cdfd0ba0 md5=3b3833921d67f0fe66da6a03e422abf1 |
Edit | https://github.com/ocaml/opam-repository/tree/master/packages/md2mld/md2mld.0.3.0/opam |
Required by
- data-encodingwith-test & >=0.7
- neural_nets_libwith-doc
- ppx_minidebug>=1.0.0
- rpc>=6.1.0 & <7.1.0
- testu01