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.6.0/mdx-1.6.0.tbz
sha256=6b4c51c91953218b5b5b14f8e5d3dd6d0c50995b46c571b97d8b37238457a4a2
sha512=f86619905828bbdaa8a93d6605308436211e26ac850cad319d92cca971e6f548e5ac07a38d01f8098f87ea7f6a40d0f4bc0c6867c3a416b2b956042423997432
StatisticsInstalled 283 times last month.
Edithttps://github.com/ocaml/opam-repository/tree/master/packages/mdx/mdx.1.6.0/opam
Required by