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.7.0/mdx-1.7.0.tbz
sha256=270e805d32923dadfaa45f09377a0863d691a2e772bb0c99bf7bd0673518ec6e
sha512=6ea55660ba3a79e4867a0b3ced2cb6bc8f46c0ce4633114365a929fb465070e46699b05daeeefc08bce83742c0e9931e55ad6cf9376d9b76313a28ebb8d05425
StatisticsInstalled 677 times last month.
Edithttps://github.com/ocaml/opam-repository/tree/master/packages/mdx/mdx.1.7.0/opam
Required by