package mdx

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

Install

github.com Readme Changelog ISC License Edit opam file

Authors

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

Maintainers

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

Sources

mdx-2.3.1.tbz
sha256=9a40a45faa78d47e29392bd4fec260d14016cac1b078e4ab016ea3adc09743f3
sha512=941d85765dc58266bf50f9eec0d67eabbc422b4f6b3e6392f5055ad09c40b3176692a598671986f84a0e926111131bdf347b2914836ebc467ae7b92c3b30c0dc

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: 27 Sep 2023

Dependencies (13)

  1. result
  2. camlp-streams
  3. ocaml-version >= "2.3.0"
  4. re >= "1.7.2"
  5. cmdliner >= "1.1.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

Used by (90)

  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. carbon
  9. cconv-ppx
  10. cid
  11. cohttp-eio
  12. containers-data >= "3.11"
  13. current_examples >= "0.6"
  14. current_git >= "0.6.1"
  15. current_incr >= "0.6.0"
  16. datalog >= "0.6"
  17. diskuvbox
  18. dkml-c-probe
  19. dolmen >= "0.8"
  20. dolmen_loop >= "0.9"
  21. domain-local-await
  22. domain-local-timeout
  23. dune-release >= "1.4.0" & < "1.5.2"
  24. eio >= "0.8.1"
  25. eio_linux
  26. eio_luv
  27. eio_main >= "0.2" & < "0.6" | >= "0.10"
  28. eio_posix
  29. electrod >= "0.5"
  30. ezcurl-lwt
  31. geojson
  32. geojsone
  33. gitlab < "0.1.1"
  34. gitlab-jsoo < "0.1.1"
  35. gitlab-unix < "0.1.1"
  36. grpc-examples
  37. hilite
  38. http-cookie >= "4.3.0"
  39. http-date
  40. ISO3166
  41. irmin-cli
  42. irmin-unix >= "3.0.0"
  43. iter != "1.2.1"
  44. kcas >= "0.2.1"
  45. kcas_data
  46. lab
  47. lambda_streams
  48. lwt_eio < "0.2" | >= "0.4"
  49. merlin >= "3.3.0" & != "3.3.4~4.10preview1" & < "3.8.0"
  50. moonpool
  51. msat = "0.8"
  52. multibase
  53. multicodec
  54. multihash-digestif
  55. odoc >= "2.0.0" & < "2.3.0"
  56. ortac-qcheck-stm
  57. owi
  58. pa_ppx_parsetree
  59. pa_ppx_q_ast >= "0.11"
  60. pa_ppx_quotation2extension
  61. pa_ppx_regexp < "0.02"
  62. pa_ppx_static < "0.02"
  63. par_incr
  64. pari
  65. pari-bindings
  66. polars
  67. polars_async
  68. ppx_deriving_yaml
  69. preface >= "1.0.0"
  70. pretty_expressive >= "0.2"
  71. printbox-html >= "0.7"
  72. printbox-text
  73. reparse >= "3.0.0"
  74. routes >= "1.0.0"
  75. rtree
  76. search
  77. spelll >= "0.3"
  78. spin = "0.6.0"
  79. thread-table < "1.0.0"
  80. tls-eio
  81. toml >= "7.1.0"
  82. topojson
  83. topojsone
  84. um-abt
  85. uring >= "0.4"
  86. wtr
  87. wtr-ppx
  88. yaml >= "1.0.0"
  89. yaml-sexp
  90. zarith-ppx

Conflicts (1)

  1. result < "1.5"