search

JohnEarnest / ok

An open-source interpreter for the K5 programming language.
MIT License
585 stars 73 forks source link

Fix markdown rendering in manual.md #72

Closed lkowalick closed 6 years ago

lkowalick commented 6 years ago

This fixes a lot of the wacky formatting in manual.md when viewed in GitHub. Combining HTML and markdown can apparently give strange results. The two main issues were:

  1. Inside the verb table:

    0 0 1 1 1 2
    &1 0 0 1 0 1
0 3 5</code></pre>

                <tt>&d</tt> indexes keys by where of values:

    which would assume that final line was code since it was indented and the line above it was blank. Removing the blank line fixes the problem.

  2. Inside the adverb descriptions:

     <a name="each"/>
 `m'l` is <b>each</b>.

    For some reason, the <a> tag completely borks the `-based code tags in the last line. Adding a blank line between them fixes the problem.

There were a few other issues as well of a similar nature. I have been using this page as a k reference, so I thought I'd make it a little nicer.

JohnEarnest commented 6 years ago

Thanks! I'd noticed that GitHub's formatter works differently from multimarkdown, and this saves me some really annoying digging around to hunt down that problem.