gildor478 / ocaml-markdown Goto Github PK

It seems that this expects some unusual variant of markdown, in which (at least) headings are indicated by preceding ! instead of preceding #. Are there other unusual variations? I'm not sure, but I think users shouldn't have to inspect the source to code to find out.

I didn't discover this until I'd spent more than hour plugging this into my system, because it's not documented anywhere that I could see. Since this package has claimed the name markdown in the opam registry, (which is itself quite misleading if it's actually an unusual variant of markdown) I think this kind of documentation on both the homepage and the package description is important.