package md2mld

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

Install

Dune Dependency

Authors

Maintainers

Sources

md2mld-0.4.0.tbz
sha256=cc8ecb0b3062c43116935a61350255a16e88dcb9b87536b65f7d7c0bd28bdf45
sha512=5ff662bceb37ff333460a9d243467aebdcac03fe7ff16e7394316dadbace2777b34f37be34b4feffeeeadfe86aeb8704a021b26f1a63575f5be7a763c7231251

Description

Published: 25 Jun 2021

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

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.

Dependencies (4)

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

Dev Dependencies

None

Used by (5)

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

Conflicts

None

OCaml

Innovation. Community. Security.