Skip to content

Commit 4a0b817

Browse files
committed
Update README with mli compatibility and dune stanza reference
This is a temporary update until we get the manual in realworldocaml#355 merged Signed-off-by: Nathan Rebours <[email protected]>
1 parent 765010b commit 4a0b817

File tree

1 file changed

+8
-13
lines changed

1 file changed

+8
-13
lines changed

README.md

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,21 @@
11
[![Build Status](https://img.shields.io/endpoint?url=https%3A%2F%2Fci.ocamllabs.io%2Fbadge%2Frealworldocaml%2Fmdx%2Fmain&logo=ocaml)](https://ci.ocamllabs.io/github/realworldocaml/mdx)
22

3-
## mdx -- executable code blocks inside markdown files
3+
## mdx -- executable code blocks inside documentation
44

5-
`mdx` allows to execute code blocks inside markdown files.
6-
There are (currently) two sub-commands, corresponding
7-
to two modes of operations: pre-processing (`ocaml-mdx pp`)
8-
and tests (`ocaml-mdx test`).
5+
`mdx` allows to execute code blocks inside markdown and mli documentation
6+
to help keeping them up to date.
97

10-
The pre-processor mode allows to mix documentation and code,
11-
and to practice "literate programming" using markdown and OCaml.
8+
Use the
9+
[dune stanza](https://dune.readthedocs.io/en/latest/dune-files.html#mdx-since-2-4)
10+
to enable it on your documentation.
1211

13-
The test mode allows to ensure that shell scripts and OCaml fragments
14-
in the documentation always stays up-to-date.
15-
16-
`mdx` is released as a single binary (called `ocaml-mdx`) and
17-
can be installed using opam:
12+
`mdx` is released on opam and can be installed by running:
1813

1914
```sh
2015
$ opam install mdx
2116
```
2217

23-
If you want to contribute or hack on the project, please see the
18+
If you want to contribute to the project, please see the
2419
[CONTRIBUTING.md](CONTRIBUTING.md).
2520

2621
### Supported Extensions

0 commit comments

Comments
 (0)