syntax for comments in github's README.md?
14,855
Huh. As a quick experiment I just tried <!-- ... -->, and it worked. Here's the example.
Related videos on Youtube
11 : 35
README files for Github using Markdown | Headings, Lists, Code Blocks, Hyperlinks | With Chanakya
08 : 56
Getting Started With GitHub, Part 3: Creating a Read Me File in Markdown
12 : 06
GitHub Profile Readme
11 : 23
Learning GitHub - How to Write MarkDown
10 : 56
46. Git Readme.md file. Learn how to write markdown syntax in the Readme file in Github Repo - GIT
Author by
Camille Goudeseune
Programmer, researcher, and church organist.
Updated on September 18, 2022Comments
-
Camille Goudeseune over 1 year
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 almost 7 yearsMuch more detail, specialized to particular programming languages, is at stackoverflow.com/questions/4823468/comments-in-markdown.