https://bugzilla.redhat.com/show_bug.cgi?id=2036396
Bug ID: 2036396 Summary: Review Request: ocaml-mdx - Executable code blocks inside markdown files Product: Fedora Version: rawhide Hardware: All OS: Linux Status: NEW Component: Package Review Severity: medium Priority: medium Assignee: nobody@fedoraproject.org Reporter: loganjerry@gmail.com QA Contact: extras-qa@fedoraproject.org CC: package-review@lists.fedoraproject.org Target Milestone: --- Classification: Fedora
Spec URL: https://jjames.fedorapeople.org/ocaml-mdx/ocaml-mdx.spec SRPM URL: https://jjames.fedorapeople.org/ocaml-mdx/ocaml-mdx-2.0.0-1.fc36.src.rpm Fedora Account System Username: jjames Description: 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.