Make sure the normalized markdown is compatible with elm-markdown

avh4 / elm-format

elm-format formats Elm source code according to a standard set of rules based on the official Elm Style Guide

BSD 3-Clause "New" or "Revised" License

1.31k stars 145 forks source link

Make sure the normalized markdown is compatible with elm-markdown #339

Open avh4 opened 7 years ago

avh4 commented 7 years ago

http://package.elm-lang.org/packages/evancz/elm-markdown/latest is what's used on package.elm-lang.org. So the normalized markdown needs to cause no ambiguities with that engine.

Comparison tool: https://johnmacfarlane.net/babelmark2/

Possibly use the marked js library in integration tests to verify things.

avh4 commented 6 years ago

The fix I want for this is a test suite that does this validation. I'm going to remove this from the 0.8.0 release, as there haven't yet been any bug reports about any issues.

gampleman commented 5 years ago

One issue I found is that elm-format transoforms:

[Scale](Scale)

into

<Scale>

which elm-markdown renders as

<Scale>

rather than

Scale

BTW the workaround is simply to write:

[Scale](./Scale)