Create
cancel
Showing results for 
Search instead for 
Did you mean: 
Sign up Log in

It's not the same without you

Join the community to find out what other Atlassian users are discussing, debating and creating.

Atlassian Community Hero Image Collage

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

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 Nov 04, 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
Community showcase
Published in Bitbucket

New improvements to user management in Bitbucket Cloud 👥

Hey Community! We’re willing to wager that quite a few of you not only use Bitbucket, but administer it too. Our team is excited to share that we’ll be releasing improvements throughout this month of...

3,920 views 10 16
Read article

Community Events

Connect with like-minded Atlassian users at free events near you!

Find an event

Connect with like-minded Atlassian users at free events near you!

Unfortunately there are no Community Events near you at the moment.

Host an event

You're one step closer to meeting fellow Atlassian users at your local event. Learn more about Community Events

Events near you