mdxversion
Executable code blocks inside markdown files
mdx allows to execute code blocks inside markdown files.
There are (currently) two sub-commands, corresponding
to two modes of operations: pre-processing (mdx pp)
and tests (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.
mdx is released as a single binary (called mdx).
| 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 | |
| Source [http] | https://github.com/realworldocaml/mdx/releases/download/1.2.0/mdx-1.2.0.tbz md5=c8237ce970b3e891d608bf061350552c |
| Edit | https://github.com/ocaml/opam-repository/tree/master/packages/mdx/mdx.1.2.0/opam |
Required by
- calculonwith-test & =0.4
- calculon-web=0.4
- carbonwith-test
- castorewith-test & >=0.0.2
- cconv-ppxwith-test
- cohttp-eiowith-test
- containerswith-test & >=2.6 & <2.7
- containers-datawith-test & >=3.11
- current_exampleswith-test & >=0.6
- current_gitwith-test & >=0.6.1
- dolmenwith-test & >=0.8
- dolmen_loopwith-test & >=0.9
- electrodwith-test & >=0.5
- ezcurl-lwtwith-test
- fuseauwith-test
- geojsonwith-test
- geojsonewith-test
- gitlabwith-test & <0.1.1
- gitlab-jsoowith-test & <0.1.1
- gitlab-unixwith-test & <0.1.1
- hilitewith-test
- http-cookiewith-test & >=4.1.0
- ISO3166with-test
- iterwith-test & <1.3
- labwith-test & <0.1.8
- lwt-pipewith-test
- msatwith-test & >=0.8
- multibasewith-test
- multicodecwith-test
- multihash-digestifwith-test
- odocwith-test & >=2.0.0 & <2.3.0
- ortac-qcheck-stmwith-test & <0.2.0
- pa_ppx_parsetree<0.02
- pa_ppx_quotation2extensionwith-test & <0.02
- pa_ppx_regexpwith-test & <0.02
- pa_ppx_staticwith-test & <0.02
- polarswith-test
- polars_asyncwith-test
- ppx_deriving_yamlwith-test & <0.2.2
- prefacewith-test
- printboxwith-test & =0.2
- reparsewith-test & >=3.0.0
- routeswith-test & !=0.7.2
- searchwith-test
- spelllwith-test & >=0.3
- spinwith-test & =0.6.0
- tls-eiowith-test
- wtrwith-test
- wtr-ppxwith-test
- yamlwith-test & >=1.0.0 & <3.1.0
- yaml-sexpwith-test & <3.1.0
- zarith-ppxwith-test
