14

A GitHub repo is described in a text file README.md, in Daring Fireball's Markdown format. Does that language support comments, either as a feature or a quick hack? I'd like to have some text that is visible when editing the file, but invisible in the HTML result. (Just like HTML's <!-- ... -->, or bash's # ....)

Their extensive example doesn't seem to mention this. Their mailing list archive isn't directly searchable, but even indirectly I find only vaguely related posts.

Camille Goudeseune
  • 2,297
  • 4
  • 32
  • 41

1 Answers1

19

Huh. As a quick experiment I just tried <!-- ... -->, and it worked. Here's the example.

Camille Goudeseune
  • 2,297
  • 4
  • 32
  • 41
  • 3
    Much more detail, specialized to particular programming languages, is at https://stackoverflow.com/questions/4823468/comments-in-markdown. – Camille Goudeseune Jun 30 '17 at 21:10