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.5.2/mdx-2.5.2.tbz
sha256=c848c2c680c62662dc4a05f558e5c6c18ed2aab7bb6508c1d49109d6ea91a3cf
sha512=847f7005557750fb996379afe372fc8d399b7a3524bc6f7c4aac5d7345314310ed827c028deb433cd241d9b70d30674951c515bf96196c9c5c691d1d0b3a07ec
Edithttps://github.com/ocaml/opam-repository/tree/master/packages/mdx/mdx.2.5.2/opam
Required by