mdx

Executable code blocks inside markdown files
Description

ocaml-mdx allows to execute code blocks inside markdown files. There are (currently) two sub-commands, corresponding to two modes of operations: pre-processing (ocaml-mdx pp) and tests (ocaml-mdx test).

The pre-processor mode allows to mix documentation and code, and to practice "literate programming" using markdown and OCaml.

The test mode allows to ensure that shell scripts and OCaml fragments in the documentation always stays up-to-date.

ocaml-mdx is released as two binaries called ocaml-mdx and mdx which are the same, mdx being the deprecated name, kept for now for compatibility.

Install
Published
09 Dec 2021
Authors
Maintainers
Sources
mdx-1.11.1.tbz
sha256=603990812efa7184d88a4896d7f9369b43d32e3dbdd26fe9cecb5a5f5f32c1e0 sha512=461bb3f2e25f8a2f869577ec8f95f731e0765a534043088fdc88ee9fabaa52926eb957124529ff889f1d698df594b235219c677521eebe01a5959c7db75131ea
Dependencies
odoc with-doc
cmdliner with-test & < "1.1.0"
alcotest with-test
lwt with-test
odoc-parser >= "0.9.0"
ocaml-version >= "2.3.0"
re >= "1.7.2"
cmdliner >= "1.0.0"
logs >= "0.7.0"
csexp >= "1.3.2"
cppo build & >= "1.1.0"
fmt >= "0.8.7"
ocaml >= "4.02.3"
dune >= "2.7"
Reverse Dependencies