How to comment out stuff in Markdown on GitHub?

markdown-comments.md

Comments in GitHub flavour of Markdown

As answers to this Stack Overflow question reveal, using <!--- and ---> or <!-- and --> works (view source by clicking "Raw"):

Inline comments

How about commenting out <!--- just ---> a part of one line?

If you know of a way, please show me how by cloning this Gist, or commenting below!

Update 2019

As several commenters pointed out, for inline commenting <!-- a normal html comment --> now works.

You can't see this:

Btw, wow, I created this gist in 2014 and only now became aware of the discussion and that it's the top Google hit for markdown comments github. 👍

http://stackoverflow.com/questions/4823468/comments-in-markdown

https://groups.google.com/forum/#!topic/pandoc-discuss/FnTRTIhCEi4

You are right

Is it just me or do inline comments work now? Cant see the <!---just--->` in the second paragraph.

This is the top result on Google for comments within markdown on GitHub and I can confirm that this now works.

I can still see the <!---just---> in the second paragraph.
EDIT: I accidentally figured out that using two '-' hyphens like <!-- instead of three <!--- works.
Here's a comment - - see raw. But this doesn't work <!--- This isn't commented out --->.

Check?

P.S. <!--- --> is working :)

Let's see if this works.

https://github.github.com/gfm/ has this:
"An HTML comment consists of <!-- + text + -->, where text does not start with > or ->, does not end with -, and does not contain --. (See the HTML5 spec.)"

I had a URL that I wanted to comment out but could not figure out how to do that. (http://foo-bar.s3-website-us-bla-1.amazonaws.com/#)

No description provided.

You can't see this:

nor this:

I believe a comment is written <!--Text--> and not <!---Text--->. The second will just cause trouble and obvious errors.

Idea for triple dash came from https://stackoverflow.com/a/4829998. Back when this gist was originally written, the normal html comment didn't work at least for inline comments.

Anyway, gist updated now, thanks for all the comments! 😏

Note that GitHub's search won't index what's in these comments.

I thought for a moment that comments are now shown, but I just checked and they aren't.

There's two comments above, in double and triple hyphens and you shouldn't be able to see them.

Try this:

[//]: # (This is a comment.)
[//]: # (This is a comment on a new line.)

Make sure add a double space after each comment line.

Thanks for putting this up!