package mdx

  1. Overview
  2. No Docs
Executable code blocks inside markdown files

Install 

dune-project
 Dependency

github.com Edit opam file Versions (22)

Authors

  1. T
    Thomas Gazagnaire <thomas@gazagnaire.org>

Maintainers

  1. T
    Thomas Gazagnaire <thomas@gazagnaire.org>

Sources

mdx-2.5.2.tbz
sha256=c848c2c680c62662dc4a05f558e5c6c18ed2aab7bb6508c1d49109d6ea91a3cf
sha512=847f7005557750fb996379afe372fc8d399b7a3524bc6f7c4aac5d7345314310ed827c028deb433cd241d9b70d30674951c515bf96196c9c5c691d1d0b3a07ec

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: 31 Mar 2026

Dependencies (13)

  1. result
  2. camlp-streams
  3. ocaml-version >= "2.3.0"
  4. re >= "1.7.2"
  5. cmdliner >= "1.1.0"
  6. logs >= "0.7.0"
  7. astring
  8. csexp >= "1.3.2"
  9. cppo build & >= "1.1.0"
  10. fmt >= "0.8.7"
  11. ocamlfind
  12. ocaml >= "4.08.0"
  13. dune >= "3.5"

Dev Dependencies (3)

  1. odoc with-doc
  2. alcotest with-test
  3. lwt with-test

  1. atacama >= "0.0.4"
  2. bastet
  3. bastet_async
  4. bastet_lwt
  5. binsec_codex
  6. brot
  7. calculon = "0.4"
  8. camlp5 >= "8.03.06"
  9. camlp5-buildscripts
  10. capnp-rpc-unix >= "1.2.4"
  11. caqti >= "2.2.4"
  12. carbon
  13. cconv-ppx
  14. cid
  15. codex
  16. cohttp-eio
  17. colors
  18. containers-data >= "3.11"
  19. current_examples >= "0.7.1"
  20. current_git >= "0.6.2"
  21. current_incr >= "0.6.0"
  22. datalog >= "0.6"
  23. diskuvbox
  24. dkml-c-probe != "3.0.0"
  25. dolmen >= "0.8"
  26. dolmen_loop >= "0.9"
  27. domain-local-await
  28. domain-local-timeout
  29. dune >= "3.17.2"
  30. dune-release >= "1.4.0" & < "1.5.2"
  31. eio >= "0.8.1" & != "1.0"
  32. eio_linux != "0.11" & != "1.0"
  33. eio_main >= "1.1"
  34. eio_posix != "1.0"
  35. electrod >= "0.5"
  36. emoji >= "2.0.0"
  37. extism >= "1.0.0"
  38. ezcurl-lwt
  39. fehu >= "1.0.0~alpha3"
  40. frama_c_codex
  41. fuseau
  42. GT >= "0.5.4"
  43. geojson
  44. geojsone
  45. gitlab < "0.1.1"
  46. gitlab-jsoo < "0.1.1"
  47. gitlab-unix < "0.1.1"
  48. grpc-examples
  49. hilite
  50. http-cookie >= "4.3.0"
  51. http-date
  52. hugin >= "1.0.0~alpha3"
  53. ISO3166
  54. irmin-cli >= "3.10.0"
  55. iter >= "1.3"
  56. kaun >= "1.0.0~alpha3"
  57. kcas >= "0.2.1"
  58. kcas_data
  59. lab
  60. lambda_streams
  61. leaves >= "0.0.2"
  62. lunar
  63. lwt_eio < "0.2" | >= "0.4"
  64. minttea >= "0.0.2"
  65. moonpool
  66. msat = "0.8"
  67. multibase
  68. multicodec
  69. multicore-bench
  70. multihash-digestif
  71. nx
  72. odoc = "2.1.1"
  73. ortac-qcheck-stm
  74. ostap >= "0.6.1"
  75. owi
  76. pa_ppx >= "0.18"
  77. pa_ppx_parsetree
  78. pa_ppx_q_ast
  79. pa_ppx_quotation2extension
  80. pa_ppx_regexp >= "0.04"
  81. par_incr
  82. pari
  83. pari-bindings
  84. parseff
  85. patricia-tree >= "0.10.0"
  86. picos < "0.5.0"
  87. picos_meta
  88. polars
  89. polars_async
  90. ppx_deriving_ezjsonm
  91. ppx_deriving_yaml
  92. ppx_minidebug >= "2.2.0"
  93. preface >= "1.0.0"
  94. pretty_expressive >= "0.2"
  95. primavera
  96. printbox-html >= "0.7"
  97. printbox-md < "0.12"
  98. printbox-text < "0.12"
  99. quill >= "1.0.0~alpha3"
  100. raven = "1.0.0~alpha2"
  101. reparse >= "3.0.0"
  102. riot >= "0.0.7"
  103. routes >= "1.0.0"
  104. rtree
  105. rune >= "1.0.0~alpha3"
  106. saturn >= "1.0.0"
  107. search
  108. smtml >= "0.7.0"
  109. sowilo >= "1.0.0~alpha3"
  110. spelll >= "0.3"
  111. spices >= "0.0.2"
  112. spin = "0.6.0"
  113. symex
  114. talon >= "1.0.0~alpha3"
  115. thread-table < "1.0.0"
  116. tls-eio
  117. toml >= "7.1.0"
  118. topojson
  119. topojsone
  120. trail
  121. um-abt
  122. uring >= "0.4"
  123. virtfs
  124. wtr
  125. wtr-ppx
  126. yaml >= "1.0.0"
  127. yaml-sexp
  128. yocaml >= "2.7.0"
  129. yocaml_cmarkit >= "2.3.0"
  130. yocaml_eio >= "2.7.0"
  131. yocaml_git >= "2.3.0"
  132. yocaml_jingoo >= "2.3.0"
  133. yocaml_liquid
  134. yocaml_markdown >= "2.4.1"
  135. yocaml_mustache >= "2.3.0"
  136. yocaml_omd >= "2.3.0"
  137. yocaml_otoml >= "2.3.0"
  138. yocaml_runtime >= "2.7.0"
  139. yocaml_syndication >= "2.3.0"
  140. yocaml_unix >= "2.3.0"
  141. yocaml_yaml >= "2.3.0"
  142. zarith-ppx

Conflicts (1)

  1. result < "1.5"