mdxversion Documentation on ocaml.org
Executable code blocks inside markdown files
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.
| Author | Thomas Gazagnaire <thomas@gazagnaire.org> |
|---|---|
| License | ISC |
| Published | |
| Homepage | https://github.com/realworldocaml/mdx |
| Issue Tracker | https://github.com/realworldocaml/mdx/issues |
| Maintainer | Thomas Gazagnaire <thomas@gazagnaire.org> |
| Dependencies | |
| Conflicts |
|
| Source [http] | https://github.com/realworldocaml/mdx/releases/download/2.6.0/mdx-2.6.0.tbz sha256=38011f9c0d0ba2044fdf8c21c530ac806211e7b730daa52827988e0c7e43763c sha512=9c5c26abfb5437aa89dff4c2f24c68e788d9d564a0210d5fa0857a259e50c82e0cf642e24c8bbb1f25f6bb04287cdb369f135220172478c7dd02429a5879410b |
| Edit | https://github.com/ocaml/opam-repository/tree/master/packages/mdx/mdx.2.6.0/opam |
Required by
- atacamawith-test & >=0.0.4
- bastetwith-test
- bastet_asyncwith-test
- bastet_lwtwith-test
- binsec_codexwith-test
- brotwith-test
- camlp5with-test & >=8.03.06
- camlp5-buildscriptswith-test
- capnp-rpc-unixwith-test & >=1.2.4
- caqtiwith-test & >=2.2.4
- carbonwith-test
- cascadewith-test
- cidwith-test
- codexwith-test
- cohttp-eiowith-test
- colorswith-test
- containers-datawith-test & >=3.11
- current_exampleswith-test & >=0.7.1
- current_gitwith-test & >=0.6.2
- current_incrwith-test & >=0.6.0
- datalogwith-test & >=0.6
- diskuvboxwith-test
- dkml-c-probewith-test & !=3.0.0
- dolmenwith-test & >=0.8
- dolmen_loopwith-test & >=0.9
- domain-local-awaitwith-test
- domain-local-timeoutwith-test
- dunewith-dev-setup & >=3.17.2
- dune-releasewith-test & >=1.4.0 & <1.5.2
- eiowith-test & >=0.8.1 & !=1.0
- eio_linuxwith-test & !=0.11 & !=1.0
- eio_mainwith-test & >=1.1
- eio_posixwith-test & !=1.0
- electrodwith-test
- emojiwith-test & >=2.0.0
- extismwith-test & >=1.0.0
- ezcurl-lwtwith-test
- fehuwith-test & >=1.0.0~alpha3
- frama_c_codexwith-test
- fuseauwith-test
- GTwith-test & >=0.5.4
- geojsonwith-test
- geojsonewith-test
- gitlabwith-test & <0.1.1
- gitlab-jsoowith-test & <0.1.1
- gitlab-unixwith-test & <0.1.1
- grpc-exampleswith-test
- hedgehogwith-test
- hilitewith-test
- http-cookiewith-test & >=4.3.0
- http-datewith-test
- huginwith-test & >=1.0.0~alpha3
- ISO3166with-test
- irmin-cliwith-test & >=3.10.0
- iterwith-test & >=1.3
- kaunwith-test & >=1.0.0~alpha3
- kcaswith-test & >=0.2.1
- kcas_datawith-test
- labwith-test
- lambda_streamswith-test
- leaveswith-test & >=0.0.2
- lunarwith-test
- lwt_eiowith-test & (<0.2 | >=0.4)
- mintteawith-test & >=0.0.2
- moonpoolwith-test
- msatwith-test & =0.8
- multibasewith-test
- multicodecwith-test
- multicore-benchwith-test
- multihash-digestifwith-test
- nxwith-test
- odocdev & =2.1.1
- openrouter_apiwith-test & >=0.1.0
- ortac-qcheck-stmwith-test
- ostapwith-test & >=0.6.1
- owiwith-test
- pa_ppxwith-test & >=0.18
- pa_ppx_fmtformatwith-test
- pa_ppx_parsetreewith-test
- pa_ppx_q_astwith-test
- pa_ppx_quotation2extensionwith-test
- pa_ppx_regexpwith-test & >=0.04
- pa_ppx_staticwith-test & >=8.05.01
- par_incrwith-test
- pari
- pari-bindings
- parseffwith-test
- patricia-treewith-test & >=0.10.0
- picoswith-test & <0.5.0
- picos_metawith-test
- polarswith-test
- polars_asyncwith-test
- ppx_deriving_ezjsonmwith-test
- ppx_deriving_yamlwith-test
- ppx_minidebug>=2.2.0
- prefacewith-test & >=1.0.0
- pretty_expressivewith-test & >=0.2
- primaverawith-test
- printbox-htmlwith-test & >=0.7
- printbox-mdwith-test & <0.12
- printbox-textwith-test & <0.12
- quillwith-test & >=1.0.0~alpha3
- ravenwith-test & =1.0.0~alpha2
- reparsewith-test & >=3.0.0
- riotwith-test & >=0.0.7
- routeswith-test & >=1.0.0
- rtreewith-test
- runewith-test & >=1.0.0~alpha3
- saturnwith-test & >=1.0.0
- searchwith-test
- sluglinewith-test
- smtmlwith-test & >=0.7.0
- soteriawith-test
- sowilowith-test & >=1.0.0~alpha3
- spelllwith-test & >=0.3
- spiceswith-test & >=0.0.2
- spinwith-test & =0.6.0
- symexwith-test
- talonwith-test & >=1.0.0~alpha3
- thread-tablewith-test & <1.0.0
- tls-eiowith-test
- tomlwith-test & >=7.1.0
- topojsonwith-test
- topojsonewith-test
- trailwith-test
- twwith-test
- um-abtwith-test
- union-find-latticewith-test
- uringwith-test & >=0.4
- virtfswith-test
- wirewith-test & >=1.0.0
- wtrwith-test
- wtr-ppxwith-test
- yamlwith-test & >=1.0.0
- yaml-sexpwith-test
- yocamlwith-test & >=2.7.0
- yocaml_cmarkitwith-test & >=2.3.0
- yocaml_eiowith-test & >=2.7.0
- yocaml_gitwith-test & >=2.3.0
- yocaml_jingoowith-test & >=2.3.0
- yocaml_liquidwith-test
- yocaml_markdownwith-test & >=2.4.1
- yocaml_mustachewith-test & >=2.3.0
- yocaml_omdwith-test & >=2.3.0
- yocaml_otomlwith-test & >=2.3.0
- yocaml_runtimewith-test & >=2.7.0
- yocaml_syndicationwith-test & >=2.3.0
- yocaml_unixwith-test & >=2.3.0
- yocaml_yamlwith-test & >=2.3.0
- zarith-ppxwith-test
