package mdx

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

Install

Dune Dependency

Authors

Maintainers

Sources

mdx-2.5.0.tbz
sha256=c2da58d7d5182f15c046fb320bb02c16602d2ee7cb99f349e3f4841c26365029
sha512=d16d9ec2ac444880c7f6d08181fe055697f25fb405358acee396cd7ecba8011881f1de8b49bfa208d4adcd4904b600f4122d1a47d98bf26a8cb533770dd9350d

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: 07 Dec 2024

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. calculon = "0.4"
  6. calculon-web = "0.4"
  7. camlp5-buildscripts
  8. capnp-rpc-unix >= "1.2.4"
  9. carbon
  10. cconv-ppx
  11. cid
  12. cohttp-eio
  13. colors
  14. containers-data >= "3.11"
  15. current_examples >= "0.7.0"
  16. current_git >= "0.6.1"
  17. current_incr >= "0.6.0"
  18. datalog >= "0.6"
  19. diskuvbox
  20. dkml-c-probe < "3.0.0"
  21. dolmen >= "0.8"
  22. dolmen_loop >= "0.9"
  23. domain-local-await
  24. domain-local-timeout
  25. dune >= "3.17.0"
  26. dune-release >= "1.4.0" & < "1.5.2"
  27. eio >= "0.8.1" & != "1.0"
  28. eio_linux != "0.11" & != "1.0"
  29. eio_main >= "1.1"
  30. eio_posix != "1.0"
  31. electrod >= "0.5"
  32. extism >= "1.0.0"
  33. ezcurl-lwt
  34. fuseau
  35. geojson
  36. geojsone
  37. gitlab < "0.1.1"
  38. gitlab-jsoo < "0.1.1"
  39. gitlab-unix < "0.1.1"
  40. grpc-examples
  41. hilite
  42. http-cookie >= "4.3.0"
  43. http-date
  44. ISO3166
  45. irmin-cli >= "3.8.0"
  46. irmin-unix >= "3.0.0" & < "3.2.1" | = "3.3.0"
  47. iter != "1.2.1"
  48. kcas >= "0.2.1"
  49. kcas_data
  50. lab
  51. lambda_streams
  52. leaves >= "0.0.2"
  53. lwt_eio < "0.2" | >= "0.4"
  54. merlin != "3.3.4~4.10preview1" & < "3.8.0"
  55. minttea >= "0.0.2"
  56. moonpool
  57. msat = "0.8"
  58. multibase
  59. multicodec
  60. multicore-bench
  61. multihash-digestif
  62. odoc >= "2.0.0" & < "2.3.0"
  63. ortac-qcheck-stm
  64. owi
  65. pa_ppx_parsetree
  66. pa_ppx_q_ast >= "0.11"
  67. pa_ppx_quotation2extension
  68. pa_ppx_regexp != "0.02"
  69. pa_ppx_static < "0.02"
  70. par_incr
  71. pari
  72. pari-bindings
  73. patricia-tree >= "0.10.0"
  74. picos < "0.5.0"
  75. picos_meta
  76. polars
  77. polars_async
  78. ppx_deriving_ezjsonm
  79. ppx_deriving_yaml
  80. preface >= "1.0.0"
  81. pretty_expressive >= "0.2"
  82. printbox-html >= "0.7"
  83. printbox-md < "0.12"
  84. printbox-text < "0.12"
  85. reparse >= "3.0.0"
  86. riot >= "0.0.7"
  87. routes >= "1.0.0"
  88. rtree
  89. saturn >= "1.0.0"
  90. search
  91. smtml >= "0.3.1"
  92. spelll >= "0.3"
  93. spices >= "0.0.2"
  94. spin = "0.6.0"
  95. thread-table < "1.0.0"
  96. tls-eio
  97. toml >= "7.1.0"
  98. topojson
  99. topojsone
  100. trail
  101. um-abt
  102. uring >= "0.4"
  103. wtr
  104. wtr-ppx
  105. yaml >= "1.0.0"
  106. yaml-sexp
  107. yocaml >= "2.1.0"
  108. yocaml_cmarkit >= "2.1.0"
  109. yocaml_eio >= "2.1.0"
  110. yocaml_git >= "2.1.0"
  111. yocaml_jingoo >= "2.1.0"
  112. yocaml_mustache >= "2.1.0"
  113. yocaml_omd >= "2.1.0"
  114. yocaml_otoml >= "2.1.0"
  115. yocaml_runtime >= "2.1.0"
  116. yocaml_syndication >= "2.1.0"
  117. yocaml_unix >= "2.1.0"
  118. yocaml_yaml >= "2.1.0"
  119. zarith-ppx

Conflicts (1)

  1. result < "1.5"
OCaml

Innovation. Community. Security.