Forums

Articles
Create
cancel
Showing results for 
Search instead for 
Did you mean: 

How do we store comments in README.MD markdown here on bitbucket?

David Tawater
I'm New Here
I'm New Here
Those new to the Atlassian Community have posted less than three times. Give them a warm welcome!
November 4, 2020

The markdown specification states that if we use <!-- --> we can store comments that do not render with the rest of the README.  this does not appear to work in bitbucket repositories.  this does work on github repositories.  is there another method of storing non-rendered text in markdown syntax?

1 answer

1 accepted

1 vote
Answer accepted
Daniel Eads
Atlassian Team
Atlassian Team members are employees working across the company in a wide variety of roles.
November 4, 2020

Hi David, welcome to the Community!

Some HTML tags are not currently supported in Bitbucket Cloud's implementation of markdown. This is tracked as a suggestion for Bitbucket Cloud: BCLOUD-6930 .

As a workaround, you can put comments in with the following format in your markdown files and they won't be rendered:

[comment]: # (These are my comments)

Cheers,

Daniel

Suggest an answer

Log in or Sign up to answer
TAGS
AUG Leaders

Atlassian Community Events