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.11.0/mdx-1.11.0.tbz
sha256=9d8301f83aa780f856b65cc5aa6fd2cecaba2c9c211923f38a11a636a07368c2
sha512=39c3e7a9164e16cc8cc89866c87c36272d3aa34aae7ccc5520b5aedecf4c8f517d8a5c7366cdb525c8e3c618f512d886bfabf2a48d8f5c31f4834bf72d7f2931
StatisticsInstalled 51 times last month.
Edithttps://github.com/ocaml/opam-repository/tree/master/packages/mdx/mdx.1.11.0/opam
Required by