package mdx

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

Install

Dune 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-1.10.0.tbz
sha256=347209c2286ba491cf0d1da0afdbe27cc3ab2c640350c3df8093257672eb940c
sha512=00985ea419719c28e01ec1c66ad2ac0f7f16e0d30351ab4ed7d96fc1503f0fde9d135d7417dd309d4cb3508aca24061d3eed5d5065c60d2968ab189af1fb9d22

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.

ocaml-mdx is released as two binaries called ocaml-mdx and mdx which are the same, mdx being the deprecated name, kept for now for compatibility.

Published: 05 Jul 2021

Dependencies (13)

  1. odoc >= "1.4.1" & < "2.0.0"
  2. ocaml-version >= "2.3.0"
  3. result
  4. re >= "1.7.2"
  5. cmdliner >= "1.0.0"
  6. logs >= "0.7.0"
  7. astring
  8. csexp >= "1.3.2"
  9. cppo build & >= "1.1.0"
  10. fmt >= "0.8.5"
  11. ocamlfind >= "1.7.2"
  12. ocaml >= "4.02.3" & < "4.13"
  13. dune >= "2.2"

Dev Dependencies (3)

  1. cmdliner with-test & < "1.1.0"
  2. alcotest with-test
  3. lwt with-test

Used by (76)

  1. bastet
  2. bastet_async
  3. bastet_lwt
  4. calculon = "0.4"
  5. calculon-web = "0.4"
  6. carbon
  7. castore >= "0.0.2"
  8. cconv-ppx
  9. cohttp-eio
  10. containers >= "2.8" & < "3.0"
  11. containers-data >= "3.11"
  12. current_examples >= "0.6"
  13. current_git >= "0.6.1"
  14. current_incr >= "0.6.0"
  15. datalog >= "0.6"
  16. dolmen >= "0.8"
  17. dolmen_loop >= "0.9"
  18. domain-local-await < "1.0.1"
  19. domain-local-timeout < "1.0.1"
  20. dune-release >= "1.4.0" & < "1.5.2"
  21. eio = "0.8.1"
  22. eio_linux < "0.9"
  23. eio_luv >= "0.6" & < "0.9"
  24. eio_main >= "0.2" & < "0.9"
  25. electrod >= "0.5"
  26. ezcurl-lwt
  27. fuseau
  28. geojson
  29. geojsone
  30. gitlab < "0.1.1"
  31. gitlab-jsoo < "0.1.1"
  32. gitlab-unix < "0.1.1"
  33. hilite
  34. http-cookie >= "4.1.0"
  35. ISO3166
  36. iter
  37. kcas >= "0.2.1" & < "0.7.0"
  38. kcas_data < "0.7.0"
  39. lab < "0.1.8"
  40. lambda_streams
  41. lwt-pipe
  42. lwt_eio
  43. merlin >= "3.3.0" & != "3.3.4~4.10preview1" & < "4.1-411"
  44. moonpool
  45. msat >= "0.8"
  46. multibase
  47. multicodec
  48. multihash-digestif
  49. odoc >= "2.0.0" & < "2.3.0"
  50. ortac-qcheck-stm < "0.2.0"
  51. pa_ppx_parsetree < "0.02"
  52. pa_ppx_quotation2extension < "0.02"
  53. pa_ppx_regexp < "0.02"
  54. pa_ppx_static < "0.02"
  55. polars
  56. polars_async
  57. ppx_deriving_yaml < "0.2.2"
  58. preface
  59. printbox = "0.2"
  60. printbox-html >= "0.7"
  61. printbox-md
  62. printbox-text
  63. reparse >= "3.0.0"
  64. routes != "0.5.2" & != "0.7.2"
  65. search
  66. spelll >= "0.3"
  67. spin = "0.6.0"
  68. thread-table < "1.0.0"
  69. tls-eio
  70. topojson
  71. topojsone
  72. wtr
  73. wtr-ppx
  74. yaml >= "1.0.0" & < "3.1.0"
  75. yaml-sexp < "3.1.0"
  76. zarith-ppx

Conflicts

None