When your markdown README files on GitHub are broken as of lately
Posted by jpluimers on 2017/04/18
Basically below gist tells it all.
Many repositories on GitHub do not have whitespace between the # and headings. This is against the specs, so GitHub fixed their rendering engine. Which means now many files do not render nicely any more.
So if you have headings like this:
Fix them to be like:
If your GitHub repository has less than 50 starts, you did not get an automatic pull request to fix it from https://github.com/bryant1410/readmesfix so you can either:
- do a manual check
- download 4.5+ gigabyte of this dataset and verify your repository is among the 16 million checked ones: GitHub readme files – dataset by vmarkovtsev | data.world