realworldocaml / mdx

Execute code blocks inside your documentation
ISC License
268 stars 45 forks source link

Add note about using mdx with mli files #411

Closed mooreryan closed 1 year ago

mooreryan commented 1 year ago

By default, Dune only processes markdown files with mdx. This note gives an example of how to use Dune and mdx in mli files.

It's just a small change to the readme, but if it was there, it would have saved me a few minutes skimming through the Dune docs to figure out what to do. Do you think it is a helpful addition to the readme?

Leonidas-from-XIV commented 1 year ago

Sounds good to me, thanks for your contribution!