How can you insert comments in the markdown document?
Issue #15
new
There does not seem to be a way. We like to keep documentation in bitbucket as well, in markdown format. It's very limiting not to be able to have comments (that will not render) in the document.
Comments (38)
-
-
@jgprog It doesn't seem to work, shown in this snippet
-
I'd also like to be able to have comments on bitbucket markdown, as it is supported in most other markdown flavours. For example, it would enable (hidden) comments automatically inserted by tools such as https://github.com/thlorenz/doctoc
-
Yes, the [original markdown specification] (http://daringfireball.net/projects/markdown/) made it clear that raw HTML should work in markdown. Also, simply using
<!-- comments to myself .. not to be read -->syntax is both easy to type and read, exactly according to the philosophy of markdown.
-
-
+1 for the HTML-style comments. It is very important. @dj_hartman thanks for the workaround, but this is hardly usable for multiline comments and it is against the markdown philosophy... So this is to be solved by BitBucket.
-
+1 - it's very useful to be able to turn bits of a readme on/off at times - would love to have this feature.
-
+1 - need this
-
+1.
Bitbucket Cloud should support standard markdown features.
Bitbucket Server does this. I ported a project into Bitbucket Cloud from BB Server and the readme is.. rather nasty. -
+1. doctoc works quite nicely, but the comments look downright ugly when viewed in our bitbucket server (v5.3).
-
+1
Would be great if BB can at least support CommonMark https://spec.commonmark.org
-
The two ToC generators for VSCode that I have tested both rely on
<!-- -->style comments to function and BB displays them uglifying my markdown rendering.+1 Please fix this.
-
+1 for this. Our code is formatted by Prettier and the Pragma inserted by it follows the
<!-- -->syntax -
+1 for
<!-- -->This issue remains since 2015. Could someone in the Atlassian team do something, please ? -
Seriously, Atlassian... what the heck?
-
+1 for HTML syntax <!-- -->
I don't quite understand the need to create a flavor of a simple markdown language.
-
1212
-
Account Deactivated
+1 for HTML syntax <!-- -->
What a pain
-
Why the hell isn’t this supported!
ಠ_ಠ
-
+1
-
Account Deactivated
+1 Please support this
-
+1 Come on, please fix this… Don’t make your own standard.
-
What if you want to make a multi-line comment, such as an empty table, to be filled in later? +100 for HTML style comments please
-
Account Deactivated
Why is this still an issue after 4 years?
-
I really dont understand why comments and image resizing is not supported in the README.md ? These issues are really much better solved in github.
-
The fact that this remains an issue with BB after 5 years is inexcusable.
-
+1 add it!
-
This is a basic missing feature…
-
yes please
-
Implementing the https://commonmark.org/ spec can’t be that difficult can it?
-
Account Deactivated
Really basic and missing feature..
Disappointed
-
+1
-
I’ve just encountered this issue. I was trying to use the REUSE 3 spec at https://reuse.software/ for specifying the license and copyright. This relies on <!-- --> comments in markdown like this.
<!-- SPDX-FileCopyrightText: 2021 Foo --> <!-- SPDX-License-Identifier: GPL-2.0-only -->
-
Open issues for bamboo cloud markdown: https://jira.atlassian.com/browse/BCLOUD-18559?filter=98686&jql=project %3D BCLOUD AND resolution %3D Unresolved AND text ~ "markdown" ORDER BY priority DESC%2C updated DESC
And specifically allowing HTML in markdown: https://jira.atlassian.com/browse/BCLOUD-6930
-
Account Deactivated
It’s mind-blowing to me that this has been open since 2015. It’s basic functionality! All of your competitors have it!
-
Yikes.
-
Neither `[comment]: # ` works for me. This is strongly needed. +1
-
I just ran into needing this exact functionality. Why are BB so far behind the curve on so many things?
- Log in to comment
Hi, You would like to add comment on your document and are hidden on page renderer ? Add HTML comment <!-- -->
Best regards