search

SoftwareVerde / bitcoin-cash-specification

Specification of the Bitcoin Cash protocols and consensus
Other
8 stars 5 forks source link

Fix markdown issues #16

Closed zander closed 3 years ago

zander commented 3 years ago

trailing spaces, especially in tables, cause some markdown renderers to fail.

Notice that trailing spaces is part of the markdown spec, a double space equals a BR.

thesquaregroot commented 3 years ago

We used HTML entities for the angle brackets around the email addresses in the BIPs because we found it was often interpreted as an HTML tag and therefore not rendered. If there's a better way to solve this though we're open to suggestions.

Everything else looks good, though.

zander commented 3 years ago

The angle brackets are rendered as html entities in various major markdown renders.

I don't know which markdown renderer you guys use, but since we can't fix github/gitlab/gohugo and likely other markdown renderers, I think the best way forward is to try and look in the stack you guys use.

thesquaregroot commented 3 years ago

Ah, I see what you mean now, sorry about that. In that case this is good to merge and we'll figure out an appropriate fix on our end separately.