mdx
Executable code blocks inside markdown files

Install

Authors

Maintainers

Sources

mdx-2.3.0.tbz
sha256=32a08398100afd2d2e7988bc3b45c9b69971271f7ab708851ded3843c9470661
sha512=b16d257fa9e515318dba22a1eb7a19f59c40414cdbeaaee0e48b6384f74b56497fd0e547b234a1329b7334d2fbdbb7c256fdf8406ae1d1f85b49dd5c5025eba2

Description

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.

Published: 17 Apr 2023