Blank line in HTML table confusing GitHub's Markdown parser
siliconforks opened this issue · comments
Bug Report
- Yes, I reviewed the contribution guidelines.
- Yes, more specifically, I reviewed the guidelines on how to write clear bug reports.
Describe the current, buggy behavior
If you view the file config.md on GitHub, and look at the "Global parameters" section, you will see a strange code snippet containing </tbody> just before the table.
This is apparently caused by a blank line in the HTML code for the table, which somehow confuses GitHub's markdown parser.
This </tbody> code snippet is appearing only on GitHub - in https://make.wordpress.org/cli/handbook/references/config/ it is not showing up. (Presumably make.wordpress.org is using a different markdown parser, which is not bug-for-bug identical to the one GitHub is using.) Still, it seems like it would be best to remove the blank line, to avoid the problem in GitHub's rendering of the file.
Describe how other contributors can replicate this bug
Simply view config.md on GitHub (not on make.wordpress.org).
Describe what you would expect as the correct outcome
The </tbody> should not be displayed.
Let us know what environment you are running this on
It should be possible to view this issue in any web browser (I tested Firefox and Chromium), although they may render it a bit differently (the generated HTML is not entirely valid).
Provide a possible solution
If you view the following version which does not contain the blank line, you will see that the </tbody> code snippet is gone:
Provide additional context/Screenshots
Here is a screenshot of GitHub rendering config.md:
