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.9.0.tbz
sha256=f94e414d38d306e4f23e017f93ac96ca75cbefedd3800414a1cbaab1f6a59eab
sha512=71dcb1ed6188994f4ad2cdd3dbf8006318f6a7ec88683c46c9df5ef73c677542e89e1e7e2ba8ab99ea69be1b43db66f33489490b8a18835e5decceafecf9ca80

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: 04 Jun 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 (63)

  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. datalog >= "0.6"
  15. dolmen >= "0.8"
  16. dolmen_loop >= "0.9"
  17. dune-release >= "1.4.0" & < "1.5.2"
  18. electrod >= "0.5"
  19. ezcurl-lwt
  20. fuseau
  21. geojson
  22. geojsone
  23. gitlab < "0.1.1"
  24. gitlab-jsoo < "0.1.1"
  25. gitlab-unix < "0.1.1"
  26. hilite
  27. http-cookie >= "4.1.0"
  28. ISO3166
  29. iter
  30. lab < "0.1.8"
  31. lambda_streams
  32. lwt-pipe
  33. merlin >= "3.3.0" & != "3.3.4~4.10preview1" & < "4.1-411"
  34. moonpool
  35. msat >= "0.8"
  36. multibase
  37. multicodec
  38. multihash-digestif
  39. odoc >= "2.0.0" & < "2.3.0"
  40. ortac-qcheck-stm < "0.2.0"
  41. pa_ppx_parsetree < "0.02"
  42. pa_ppx_quotation2extension < "0.02"
  43. pa_ppx_regexp < "0.02"
  44. pa_ppx_static < "0.02"
  45. polars
  46. polars_async
  47. ppx_deriving_yaml < "0.2.2"
  48. preface
  49. printbox = "0.2"
  50. printbox-html >= "0.7"
  51. printbox-md
  52. printbox-text
  53. reparse >= "3.0.0"
  54. routes != "0.5.2" & != "0.7.2"
  55. search
  56. spelll >= "0.3"
  57. spin = "0.6.0"
  58. tls-eio
  59. wtr
  60. wtr-ppx
  61. yaml >= "1.0.0" & < "3.1.0"
  62. yaml-sexp < "3.1.0"
  63. zarith-ppx

Conflicts

None