CIP-0054 | Fix API headers for markdown portability #591
Conversation
\< is supported by GitHub but not part of Markdown spec.
SmaugPool
force-pushed
the
cip54-fix-rendering
branch
from
8490f97
to
d8439f9
Compare
SmaugPool
changed the title
SmaugPool
changed the title
There was a problem hiding this comment.
@SmaugPool can you anticipate any problems with Showdown rendering if these API headers were more properly typeset as code? https://gist.github.com/rphair/d206e385ef694396841f765a6dd27696
rphair
changed the title
|
p.s. @SmaugPool @Ryun1 this is also an issue for CIP-0030 (I just checked all merged CIP |
Inline code in the headers also solves the issue but it's displayed differently, and I didn't want to change the author formatting intention. I guess it's also an acceptable solution though if preferred. |
|
OK @SmaugPool @Ryun1 let's put this through then (unless @kieransimkin has any objections) and after it's agreed upon I'll submit a PR to update CIP-0030 the same way... this may require some care because of potential merge conflicts with pending CIP-0030 updates, so I think we should keep the 2 sets of changes separate. |
…on#591) * CIP-0054 | Fix showdown rendering by escaping HTML with < \< is supported by GitHub but not part of Markdown spec. * change header to use code markdown: 1 of 5 * change header to use code markdown: 2 of 5 * change header to use code markdown: 3 of 5 * change header to use code markdown: 4+5 of 5 --------- Co-authored-by: Robert Phair <[email protected]>
\<is supported by GitHub to escape HTML but not part of Markdown spec and not supported by showdown, breaking CIP-0054 rendering on https://cips.cardano.org/:By escaping instead the opening angle bracket with
<, both GitHub and showdown rendering work correctly:GitHub rendering:
https://github.com/SmaugPool/CIPs/tree/cip54-fix-rendering/CIP-0054
FYI: @kieransimkin