search

uphold / docs

Uphold API Reference
https://uphold.com/en/developer/api/documentation/
48 stars 39 forks source link

Fix usage of markdown inside HTML blocks #189

Closed waldyrious closed 4 years ago

waldyrious commented 4 years ago

Interaction between markdown and HTML blocks is currently complex and has many edge cases, especially related to whitespace and blank lines. See the examples in the spec: https://spec.commonmark.org/0.29/#html-blocks

This was the cause of some unprocessed formatting (mostly code fenced with backticks) inside some of the <aside> blocks, as can be seen in the _cards.md, _entities.md and _transactions.md pages.

The unreliability of markdown inside the <aside> is actually documented in the slate wiki, and has been the cause of various issues: https://github.com/slatedocs/slate/issues/183, https://github.com/slatedocs/slate/issues/236, https://github.com/slatedocs/slate/issues/270.

As a solution (and standardizing on a practice that was already present in various pages of this project) all formatting inside <aside> blocks is converted to HTML.

This way the content becomes robust to such flaky interactions, and the existing cases are fixed.

waldyrious commented 4 years ago

/cc @nunofgs — this is the same fix as #79.