I'm trying to create a gist with an inline comment. I read a solution here which works for putting a comment on it's own line (as shown in the image); however, it doesn't appear to work for inline comments. Is there any way to get inline comments in github flavored markdown?
- [x] some item
- [ ] another item with meta info [//]: # (attempt at meta info as inline comment)
[//]: # (This may be the most platform independent comment)
[//]: # (https://stackoverflow.com/questions/4823468/comments-in-markdown)
Adding HTML Comments in Markdown Unlike a "normal" HTML comment which opens with <! -- (two dashes), an HTML comment in Markdown opens with <! --- (three dashes). Some Markdown parsers support two-dash HTML comments, but the three-dash version is more universally compatible.
Turn on Markdown Formatting for notes. For this, go to Tools > Options > Appearance and check "Use Markdown format in notes".
On the pull request, click Files changed. Hover over the line of code where you'd like to add a comment, and click the blue comment icon. To add a comment on multiple lines, click and drag to select the range of lines, then click the blue comment icon. When you're done, click Add single comment.
To create a horizontal line, use three or more asterisks ( *** ), hyphens ( --- ), or underscores ( ___ ): Some text! ---Next chapter or something!
You can also just do this
<!--- Comments are Fun --->
Remember, markdown is just an easier way to write HTML content. (note the triple dash)
looking more closely at this solution a possible workaround for inline comments:
- [x] some item
- [ ] another item with meta info [//]: # (attempt at meta info as inline comment)
- [ ] using @ig0774's recomendation [](with an inline comment hidden inside an empty link)
[//]: # (This may be the most platform independent comment)
[//]: # (https://stackoverflow.com/questions/4823468/comments-in-markdown)
[](and another comment down here too using the empty link method)
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With