package mdx

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

Install

Dune Dependency

Authors

Maintainers

Sources

mdx-1.8.0.tbz
sha256=a248a58792c132f5b63982148ad85cc1d531a354cbbdd08156e108d5c6b951dc
sha512=1233893859b0f67a43759ec0c1c795dbbffa40555eb37440ea161dc3f773b8724f368d749a05555687244a62af8036a97357bec86376659d70f3d9d4355496e2

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: 18 Jan 2021

Dependencies (13)

  1. odoc >= "1.5.0" & < "2.0.0"
  2. ocaml-version >= "2.3.0"
  3. ocaml-migrate-parsetree >= "1.4.0" & < "2.0.0"
  4. result
  5. re >= "1.7.2"
  6. cmdliner >= "1.0.0"
  7. logs >= "0.5.0"
  8. astring
  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 (61)

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

Conflicts

None