mseri / md2mld Goto Github PK

md2mld (version 0.3.0 from OPAM) does not seem to escape brackets from Markdown. If I take the file:

Here is some text [...] and then some more.

Here is a bracket: [

Here is a closing bracket: ]

I get an identical .mld file. If I then give this file to odoc, it complains and produces an HTML like the following:

where the brackets have been interpreted as code. It should look like the following in Markdown:

Hi,

Sorry for the naive question but md2mld seems to replace every occurrence of ( and ) with \( and \) whereas only []{}@ seem to need escaping according to the ocamldoc docs.

Am I missing something? I'll be happy to propose a patch if this is a mistake 🙂

Cheers!

It seems to me that md2mld escapes parentheses in Markdown files, resulting in the escaping character \ showing up in the HTML. If I take a .md file:

This is an (uninteresting) sentence with (useless) parentheses.

and run md2mld (version 0.3.0 from OPAM) on it, I get:

This is an \(uninteresting\) sentence with \(useless\) parentheses.

and compiling such a file with odoc results in the \( and \) showing up in the HTML. Maybe this has to do with escaping (* and *)? But then it's a bit overzealous.

Hey there,

Thank you very much for this tool; very handy!

Would it be possible to add support for Markdown's blockquotes? Currently, I think md2mld doesn't do much with them, which leads to remaining > characters in the output HTML file (as processed with odoc). I am not sure if there is such a thing as blockquotes in MLD files, but then maybe at least remove the > files?

I don't have the time right now but I could try working on a PR adding this in a few months, if you wanted.

Example blockquotes:

Here comes a quote:

> Here is the quote.

Here comes another quote with a nested quote:

> Here is the quote.
> 
> > Here is the nested quote.

Bye!

which shows as follows, on GitHub:

Here comes a quote:

Here is the quote.

Here comes another quote with a nested quote:

Here is the quote.

Here is the nested quote.

Bye!

See cmarkit release announcment and also the example md<->mld.

Will also mostly resolve #11

Add a way to inject mld syntax, for example to automatically add the correct links to modules or types.