package mdx

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

Install

Dune Dependency

github.com Readme Changelog ISC License Edit opam file Versions (20)

Authors

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

Maintainers

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

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" & < "2.0.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. camlp5-buildscripts
  7. capnp-rpc-unix >= "1.2.4"
  8. caqti >= "2.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. emoji >= "2.0.0"
  33. extism >= "1.0.0"
  34. ezcurl-lwt
  35. fuseau
  36. GT >= "0.5.4"
  37. geojson
  38. geojsone
  39. gitlab < "0.1.1"
  40. gitlab-jsoo < "0.1.1"
  41. gitlab-unix < "0.1.1"
  42. grpc-examples
  43. hilite
  44. http-cookie >= "4.3.0"
  45. http-date
  46. ISO3166
  47. irmin-cli >= "3.8.0"
  48. irmin-unix >= "3.0.0" & < "3.2.1" | = "3.3.0"
  49. iter >= "1.3"
  50. kcas >= "0.2.1"
  51. kcas_data
  52. lab
  53. lambda_streams
  54. leaves >= "0.0.2"
  55. lwt_eio < "0.2" | >= "0.4"
  56. merlin != "3.3.4~4.10preview1" & < "3.8.0"
  57. minttea >= "0.0.2"
  58. moonpool
  59. msat = "0.8"
  60. multibase
  61. multicodec
  62. multicore-bench
  63. multihash-digestif
  64. odoc >= "2.0.0" & < "2.3.0"
  65. ortac-qcheck-stm
  66. ostap >= "0.6.1"
  67. owi
  68. pa_ppx >= "0.18"
  69. pa_ppx_parsetree
  70. pa_ppx_q_ast >= "0.11"
  71. pa_ppx_quotation2extension
  72. pa_ppx_regexp != "0.02"
  73. pa_ppx_static < "0.02"
  74. par_incr
  75. pari
  76. pari-bindings
  77. patricia-tree >= "0.10.0"
  78. picos < "0.5.0"
  79. picos_meta
  80. polars
  81. polars_async
  82. ppx_deriving_ezjsonm
  83. ppx_deriving_yaml
  84. ppx_minidebug >= "2.2.0"
  85. preface >= "1.0.0"
  86. pretty_expressive >= "0.2"
  87. printbox-html >= "0.7"
  88. printbox-md < "0.12"
  89. printbox-text < "0.12"
  90. reparse >= "3.0.0"
  91. riot >= "0.0.7"
  92. routes >= "1.0.0"
  93. rtree
  94. saturn >= "1.0.0"
  95. search
  96. smtml >= "0.3.1"
  97. spelll >= "0.3"
  98. spices >= "0.0.2"
  99. spin = "0.6.0"
  100. thread-table < "1.0.0"
  101. tls-eio
  102. toml >= "7.1.0"
  103. topojson
  104. topojsone
  105. trail
  106. um-abt
  107. uring >= "0.4"
  108. wtr
  109. wtr-ppx
  110. yaml >= "1.0.0"
  111. yaml-sexp
  112. yocaml >= "2.1.0"
  113. yocaml_cmarkit >= "2.1.0"
  114. yocaml_eio >= "2.1.0"
  115. yocaml_git >= "2.1.0"
  116. yocaml_jingoo >= "2.1.0"
  117. yocaml_mustache >= "2.1.0"
  118. yocaml_omd >= "2.1.0"
  119. yocaml_otoml >= "2.1.0"
  120. yocaml_runtime >= "2.1.0"
  121. yocaml_syndication >= "2.1.0"
  122. yocaml_unix >= "2.1.0"
  123. yocaml_yaml >= "2.1.0"
  124. zarith-ppx

Conflicts (1)

  1. result < "1.5"
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct