mdxversion

Executable code blocks inside markdown files

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.

AuthorThomas Gazagnaire <thomas@gazagnaire.org
LicenseISC
Published
Homepagehttps://github.com/realworldocaml/mdx
Issue Trackerhttps://github.com/realworldocaml/mdx/issues
MaintainerThomas Gazagnaire <thomas@gazagnaire.org>
Dependencies
Source [http] https://github.com/realworldocaml/mdx/releases/download/1.4.0/mdx-1.4.0.tbz
sha256=66b56a6bee7165498671c5a616acd965975de5cf855c7c114d7f5237a250ebdb
sha512=679d42d54fed29e5aaeb60dc01c23da6e903b976769585da06dc06a4a643fca7836d0999f09d55f6d94125f0ca99ba27b6402f5a6651a16ba5397353d742ec3d
StatisticsInstalled 400 times last month.
Edithttps://github.com/ocaml/opam-repository/tree/master/packages/mdx/mdx.1.4.0/opam
Required by