Skip to content

Support for HTML READMEs (README.html)

Hi y'all.

I'm using HTML for most of my docs and content, including READMEs. The problem is: GitLab only supports .md files with inline HTML, which is not friendly to most HTML tools out there. Browsers open .md files as plain text, GitLab itself interprets some lines as Markdown instead of HTML content, and the feedback loop for iterating on documentation is too long:

  • Add an HTML tag and content.
  • Push the changes to the repo.
  • Check whether it rendered alright.
  • Fix the HTML to fit what you think is the problem (GitLab doesn't give you any indication).

Would be nice to have plain HTML READMEs so that all the tooling works with them natively.