package md2mld

  1. Overview
  2. Docs
Little cli tool to convert md files into mld files

Install

Dune Dependency

Authors

Maintainers

Sources

md2mld-0.7.0.tbz
sha256=65bc12176cb584bb228027c4b5fba2f5362417f844686a7c19fcea2934c34a4b
sha512=e9b931919174c41ef80b3dd48091bc6be8ed219c1a3b9bddb1e80066d3bdac17f9f85a37673c720091d78fec9aeb1e6edb99d7de5a5e6f7e5b27739987eda3e5

Description

Published: 03 May 2023

README

md2mld: 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.

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
 (target outfile.mld)
 (deps filename.md)
 (action
  (with-stdout-to outfile.mld (run md2mld filename.md))))

Attach the mld file using the (documentation …) stanza. You can see the documentation generated from the latest tagged version of this README at mseri.github.io/md2mld/md2mld.

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.

Dependencies (4)

  1. omd >= "2.0.0~alpha3"
  2. base-bytes
  3. ocaml >= "4.08"
  4. dune >= "3.7"

Dev Dependencies (1)

  1. odoc with-doc

Used by (4)

  1. data-encoding >= "0.7"
  2. ppx_minidebug >= "1.0.0"
  3. rpc >= "6.1.0" & < "7.1.0" | >= "8.1.1"
  4. testu01

Conflicts

None