Executable code blocks inside markdown files

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: 23 Jan 2023

Dependencies (15)

  1. odoc with-doc
  2. alcotest with-test
  3. lwt with-test
  4. odoc-parser >= "1.0.0"
  5. ocaml-version >= "2.3.0"
  6. re >= "1.7.2"
  7. cmdliner >= "1.1.0"
  8. logs >= "0.7.0"
  9. astring
  10. csexp >= "1.3.2"
  11. cppo build & >= "1.1.0"
  12. fmt >= "0.8.7"
  13. ocamlfind
  14. ocaml >= "4.08.0"
  15. dune >= "3.5"

Reverse Dependencies (66)

  1. bastet
  2. bastet_async
  3. bastet_lwt
  4. calculon = "0.4"
  5. calculon-web = "0.4"
  6. camlp5-buildscripts
  7. capnp-rpc-unix >= "1.2.3"
  8. cconv-ppx
  9. cohttp-eio
  10. containers-data >= "3.11"
  11. current_examples >= "0.6"
  12. current_git >= "0.6.1"
  13. current_incr >= "0.6.0"
  14. datalog >= "0.6"
  15. diskuvbox
  16. dkml-c-probe
  17. dolmen >= "0.8"
  18. dune-release >= "1.4.0" & < "1.5.2"
  19. eio >= "0.8.1"
  20. eio_linux
  21. eio_luv
  22. eio_main >= "0.2"
  23. electrod >= "0.5"
  24. ezcurl-lwt
  25. geojson
  26. geojsone
  27. gitlab < "0.1.1"
  28. gitlab-jsoo < "0.1.1"
  29. gitlab-unix < "0.1.1"
  30. hilite
  31. http-cookie >= "4.3.0"
  32. http-date
  33. ISO3166
  34. irmin-cli
  35. irmin-unix >= "3.0.0"
  36. iter != "1.2.1"
  37. kcas >= "0.2.1"
  38. lab
  39. lambda_streams
  40. lwt_eio
  41. merlin >= "3.3.0" & != "3.3.4~4.10preview1" & < "3.8.0"
  42. msat = "0.8"
  43. multibase
  44. multicodec
  45. multihash-digestif
  46. odoc >= "2.0.0"
  47. owi
  48. ppx_deriving_yaml
  49. preface >= "1.0.0"
  50. printbox-text
  51. reparse >= "3.0.0"
  52. routes >= "1.0.0"
  53. search
  54. spelll >= "0.3"
  55. spin = "0.6.0"
  56. tls-eio
  57. toml >= "7.1.0"
  58. topojson
  59. topojsone
  60. um-abt
  61. uring >= "0.4"
  62. wtr
  63. wtr-ppx
  64. yaml >= "1.0.0"
  65. yaml-sexp
  66. zarith-ppx

Conflicts (1)

  1. result < "1.5"

Install

Documentation github.com Readme Changelog ISC License Edit opam file

Authors

Maintainers

Sources

mdx-2.2.1.tbz
sha256=f09ed733fe4461605f029773748a6353d01b95be65eb986bcce17d6ddaf509d8
sha512=5f918fbafcb55c3959f6cce69b8d8e640883dea5c21d159b5ebb6ead31230569100813555d2637f74028d51f79f23a226dc69811524d9cf1c2ca50b87a93dbf2