package md2mld

  1. Overview
  2. Docs
Md files into odoc mld files

Install

Dune Dependency

Authors

Maintainers

Sources

md2mld-0.2.0.tbz
sha256=f0e71cd226f0f97ce94ec4e3cb181641eb29131319ee550647bcbbd1501bdf9d
md5=a4118343f4c2b91435c38e29a3fce1c9

Description

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

Published: 22 Nov 2018

README

Convert 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)))

Dependencies (4)

  1. omd < "2.0.0~alpha1"
  2. base-bytes
  3. dune >= "1.4.0"
  4. ocaml

Dev Dependencies

None

Conflicts

None

OCaml

Innovation. Community. Security.