rpms/ocaml-mdx
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Clone of https://src.fedoraproject.org/rpms/ocaml-mdx
7 Commits 6 Branches 0 Tags 69 KiB
RPM Spec 100%
c6291bff5d
Go to file
Jerry James c6291bff5d Rebuild for ocaml-version 3.5.0. Use new OCaml macros.
2022-07-08 09:12:02 -06:00
.gitignore Initial import. 2022-01-07 11:27:42 -07:00
ocaml-mdx.spec Rebuild for ocaml-version 3.5.0. Use new OCaml macros. 2022-07-08 09:12:02 -06:00
README.md Initial import. 2022-01-07 11:27:42 -07:00
sources Version 2.1.0. 2022-02-03 16:56:42 -07:00

README.md

ocaml-mdx

mdx enables execution of code blocks inside markdown files. There are (currently) two sub-commands, corresponding to two modes of operation: preprocessing (ocaml-mdx pp) and tests (ocaml-mdx test).

The preprocessor mode enables mixing documentation and code, and the practice of "literate programming" using markdown and OCaml.

The test mode enables ensuring that shell scripts and OCaml fragments in the documentation always stay up-to-date.

The blocks in markdown files can be parameterized by mdx-specific labels, that will change the way mdx interprets the block. The syntax is: <!-- $MDX labels -->, where labels is a list of valid labels separated by a comma. This line must immediately precede the block it is attached to.