mdx

Executable code blocks inside markdown files
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.

Install
Documentation github.com Changelog ISC License Edit opam file
Published
28 Jan 2022
Authors
Maintainers
Sources
mdx-2.1.0.tbz
sha256=a25d73cbc2ce0c361d727bff8c1c84d299ea279ba342e3002eadeff72eed77fa sha512=05e86a3a4513299433583b8c7cd482edfc513b08002825ae8ec390e537139eb7dd7b9131679d181e62147f9ff0d1814a1936d2e2983fc7530dcb85e347d4b603
Dependencies
odoc with-doc
cmdliner with-test & < "1.1.0"
alcotest with-test
lwt with-test
odoc-parser >= "1.0.0"
ocaml-version >= "2.3.0"
result
re >= "1.7.2"
cmdliner >= "1.0.0"
logs >= "0.7.0"
astring
csexp >= "1.3.2"
cppo build & >= "1.1.0"
fmt >= "0.8.7"
ocamlfind
ocaml >= "4.08.0"
dune >= "2.7"
Reverse Dependencies
bastet
bastet_async
bastet_lwt
calculon = "0.4"
calculon-web = "0.4"
cconv-ppx
cohttp-eio
current_examples >= "0.6"
current_git >= "0.6.1"
current_incr >= "0.6.0"
datalog >= "0.6"
diskuvbox
dkml-c-probe
dolmen >= "0.8"
dune-release >= "1.4.0" & < "1.5.2"
eio_linux
eio_luv
eio_main >= "0.2"
electrod >= "0.5"
ezcurl-lwt
geojson
geojsone
gitlab < "0.1.1"
gitlab-jsoo < "0.1.1"
gitlab-unix < "0.1.1"
hilite
http-cookie >= "4.3.0"
http-date
ISO3166
irmin-cli
irmin-unix >= "3.0.0"
iter != "1.2.1"
lab
lambda_streams
lwt_eio
merlin >= "3.3.0" & != "3.3.4~4.10preview1" & < "3.8.0"
msat = "0.8"
multibase
multicodec
multihash-digestif
odoc >= "2.0.0"
owi
ppx_deriving_yaml
preface >= "1.0.0"
printbox-text
reparse >= "3.0.0"
routes >= "1.0.0"
search
spelll >= "0.3"
spin = "0.6.0"
tls-eio
toml >= "7.1.0"
um-abt
uring >= "0.4"
wtr
wtr-ppx
yaml >= "1.0.0"
yaml-sexp
zarith-ppx