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.2.1.tbz
sha256=f09ed733fe4461605f029773748a6353d01b95be65eb986bcce17d6ddaf509d8
sha512=5f918fbafcb55c3959f6cce69b8d8e640883dea5c21d159b5ebb6ead31230569100813555d2637f74028d51f79f23a226dc69811524d9cf1c2ca50b87a93dbf2

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 (12)

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

Dev Dependencies (3)

  1. odoc with-doc
  2. alcotest with-test
  3. lwt with-test

Used by (73)

  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. cid
  10. cohttp-eio
  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. diskuvbox
  17. dkml-c-probe
  18. dolmen >= "0.8"
  19. domain-local-await
  20. dune-release >= "1.4.0" & < "1.5.2"
  21. eio >= "0.8.1"
  22. eio_linux
  23. eio_luv
  24. eio_main >= "0.2"
  25. eio_posix
  26. electrod >= "0.5"
  27. ezcurl-lwt
  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.3.0"
  35. http-date
  36. ISO3166
  37. irmin-cli
  38. irmin-unix >= "3.0.0"
  39. iter != "1.2.1"
  40. kcas >= "0.2.1"
  41. kcas_data
  42. lab
  43. lambda_streams
  44. lwt_eio
  45. merlin >= "3.3.0" & != "3.3.4~4.10preview1" & < "3.8.0"
  46. msat = "0.8"
  47. multibase
  48. multicodec
  49. multihash-digestif
  50. odoc >= "2.0.0"
  51. owi
  52. pa_ppx_quotation2extension
  53. pa_ppx_regexp
  54. pa_ppx_static
  55. ppx_deriving_yaml
  56. preface >= "1.0.0"
  57. printbox-text
  58. reparse >= "3.0.0"
  59. routes >= "1.0.0"
  60. search
  61. spelll >= "0.3"
  62. spin = "0.6.0"
  63. tls-eio
  64. toml >= "7.1.0"
  65. topojson
  66. topojsone
  67. um-abt
  68. uring >= "0.4"
  69. wtr
  70. wtr-ppx
  71. yaml >= "1.0.0"
  72. yaml-sexp
  73. zarith-ppx

Conflicts (1)

  1. result < "1.5"