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.9.0/mdx-1.9.0.tbz
sha256=f94e414d38d306e4f23e017f93ac96ca75cbefedd3800414a1cbaab1f6a59eab
sha512=71dcb1ed6188994f4ad2cdd3dbf8006318f6a7ec88683c46c9df5ef73c677542e89e1e7e2ba8ab99ea69be1b43db66f33489490b8a18835e5decceafecf9ca80
StatisticsInstalled 29 times last month.
Edithttps://github.com/ocaml/opam-repository/tree/master/packages/mdx/mdx.1.9.0/opam
Required by