mdxversion Documentation on ocaml.org

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.

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
Conflicts
Source [http] https://github.com/realworldocaml/mdx/releases/download/2.7.0/mdx-2.7.0.tbz
sha256=e2fdaeb7e05d173ac4b8a0ed3c55da655772fef9b3ba6478f794bfdfacb7265f
sha512=261d731b32e2faa1f3db54fbe463a03b80a12b56f218a5786980f93e80b93bca8b46a85bf6bacb3cc45e2d5bf94a29003677ae7f73dd6fc0164ca5a88337c697
Edithttps://github.com/ocaml/opam-repository/tree/master/packages/mdx/mdx.2.7.0/opam
Required by