package md2mld

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

Install

Dune Dependency

Authors

Maintainers

Sources

md2mld-0.3.0.tbz
sha256=6e3706c87716ba090cbc9f43b01c468387453d77f9e45321a6a51d19cdfd0ba0
md5=3b3833921d67f0fe66da6a03e422abf1

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

You can see the documentation generated from the latest tagged version of this README at mseri.github.io/md2mld/md2mld/index.html.

Published: 23 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)))

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 >= "1.4.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"
  5. testu01

Conflicts

None

OCaml

Innovation. Community. Security.