package mdx

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

Install 

dune-project
 Dependency

github.com Edit opam file Versions (20)

Authors

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

Maintainers

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

Sources

mdx-2.6.0.tbz
sha256=38011f9c0d0ba2044fdf8c21c530ac806211e7b730daa52827988e0c7e43763c
sha512=9c5c26abfb5437aa89dff4c2f24c68e788d9d564a0210d5fa0857a259e50c82e0cf642e24c8bbb1f25f6bb04287cdb369f135220172478c7dd02429a5879410b

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.

Added to opam-repository:

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.24.2"

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. camlp5 >= "8.03.06"
  8. camlp5-buildscripts
  9. capnp-rpc-unix >= "1.2.4"
  10. caqti >= "2.2.4"
  11. carbon
  12. cascade
  13. cid
  14. codex
  15. cohttp-eio
  16. colors
  17. containers-data >= "3.11"
  18. current_examples >= "0.7.1"
  19. current_git >= "0.6.2"
  20. current_incr >= "0.6.0"
  21. datalog >= "0.6"
  22. diskuvbox
  23. dkml-c-probe != "3.0.0"
  24. dolmen >= "0.8"
  25. dolmen_loop >= "0.9"
  26. domain-local-await
  27. domain-local-timeout
  28. dune >= "3.17.2"
  29. dune-release >= "1.4.0" & < "1.5.2"
  30. eio >= "0.8.1" & != "1.0"
  31. eio_linux != "0.11" & != "1.0"
  32. eio_main >= "1.1"
  33. eio_posix != "1.0"
  34. electrod
  35. emoji >= "2.0.0"
  36. extism >= "1.0.0"
  37. ezcurl-lwt
  38. fehu >= "1.0.0~alpha3"
  39. frama_c_codex
  40. fuseau
  41. GT >= "0.5.4"
  42. geojson
  43. geojsone
  44. gitlab < "0.1.1"
  45. gitlab-jsoo < "0.1.1"
  46. gitlab-unix < "0.1.1"
  47. grpc-examples
  48. hedgehog
  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. openrouter_api >= "0.1.0"
  74. ortac-qcheck-stm
  75. ostap >= "0.6.1"
  76. owi
  77. pa_ppx >= "0.18"
  78. pa_ppx_fmtformat
  79. pa_ppx_parsetree
  80. pa_ppx_q_ast
  81. pa_ppx_quotation2extension
  82. pa_ppx_regexp >= "0.04"
  83. pa_ppx_static >= "8.05.01"
  84. par_incr
  85. pari
  86. pari-bindings
  87. parseff
  88. patricia-tree >= "0.10.0"
  89. picos < "0.5.0"
  90. picos_meta
  91. polars
  92. polars_async
  93. ppx_deriving_ezjsonm
  94. ppx_deriving_yaml
  95. ppx_minidebug >= "2.2.0"
  96. preface >= "1.0.0"
  97. pretty_expressive >= "0.2"
  98. primavera
  99. printbox-html >= "0.7"
  100. printbox-md < "0.12"
  101. printbox-text < "0.12"
  102. quill >= "1.0.0~alpha3"
  103. raven = "1.0.0~alpha2"
  104. reparse >= "3.0.0"
  105. riot >= "0.0.7"
  106. routes >= "1.0.0"
  107. rtree
  108. rune >= "1.0.0~alpha3"
  109. saturn >= "1.0.0"
  110. search
  111. slugline
  112. smtml >= "0.7.0"
  113. soteria
  114. sowilo >= "1.0.0~alpha3"
  115. spelll >= "0.3"
  116. spices >= "0.0.2"
  117. spin = "0.6.0"
  118. symex
  119. talon >= "1.0.0~alpha3"
  120. thread-table < "1.0.0"
  121. tls-eio
  122. toml >= "7.1.0"
  123. topojson
  124. topojsone
  125. trail
  126. tw
  127. um-abt
  128. union-find-lattice
  129. uring >= "0.4"
  130. virtfs
  131. wire >= "1.0.0"
  132. wtr
  133. wtr-ppx
  134. yaml >= "1.0.0"
  135. yaml-sexp
  136. yocaml >= "2.7.0"
  137. yocaml_cmarkit >= "2.3.0"
  138. yocaml_eio >= "2.7.0"
  139. yocaml_git >= "2.3.0"
  140. yocaml_jingoo >= "2.3.0"
  141. yocaml_liquid
  142. yocaml_markdown >= "2.4.1"
  143. yocaml_mustache >= "2.3.0"
  144. yocaml_omd >= "2.3.0"
  145. yocaml_otoml >= "2.3.0"
  146. yocaml_runtime >= "2.7.0"
  147. yocaml_syndication >= "2.3.0"
  148. yocaml_unix >= "2.3.0"
  149. yocaml_yaml >= "2.3.0"
  150. zarith-ppx

Conflicts (1)

  1. result < "1.5"