ocaml-tutorials

Create interactive OCaml tutorials by scaffolding a doc/ directory with tutorial.mld and index.mld files, then configuring dune for MDX support. This workflow combines narrative .mld documentation with runnable code blocks to produce verifiable, executable examples.

MDX enables executable code blocks within .mld documentation files to verify OCaml library usage. It integrates narrative content with runnable code, allowing library authors to generate step-by-step tutorials with tested, reproducible outputs.

Yes, MDX-enabled OCaml documentation requires a doc/ directory containing tutorial.mld and index.mld files, alongside a properly configured dune-project. This specific file structure ensures the reproducible publishing workflow functions correctly.

Yes, .mld files are the source format for generating reproducible OCaml library documentation. By annotating .mld sources with MDX, you create an integrated workflow that validates code examples and produces verifiable tutorial outputs.

The best way to scaffold an OCaml tutorial project is creating the required doc/, tutorial.mld, and index.mld files, then updating the dune-project for MDX support. This establishes a reproducible publishing workflow tailored for library authors and educators.

Use MDX for OCaml tutorials because standard markdown cannot execute and verify code blocks. MDX integrates with .mld sources to run examples, ensuring library documentation remains accurate and reproducible during updates.