Community
Q&A
Bitbucket
Questions
Why does Bitbucket render Markdown files (.md) file differently than CommonMark?

Why does Bitbucket render Markdown files (.md) file differently than CommonMark?

I have a CHANGELOG.md file that I have created for my respoitory where I list the issues resolved in the latest release of code. I am using the following syntax between release entries:

## [x.y.z](https://bitbucket.org/{repository}/commits/tag/x.y.z) {Description} (YYYY-MM-DD)
### Improvements- [JIRA {issue id}](issue URL) {Description}

---
## [x.y.y](https://bitbucket.org/{repository}/commits/tag/x.y.y) {Description} (YYYY-MM-DD)

The problem comes up when I try view the file online in Bitbucket its not ignoring the break ( ). When I view this in CommonMark the reference provided in the documentation it works as expected, but not when I view the file online in Bitbucket.

1 answer

1 accepted

Comments for this post are closed

Community moderators have prevented the ability to post new answers.

0 votes

Answer accepted

Hi Jonathan,

I'm afraid that we don't support arbitrary HTML in Markdown, which is why you can view in your .md file instead of a line break.

That being said, we have a Labs feature to allow some HTML tags to be embedded in markdown files.

If you log in to Bitbucket Cloud website, then go to your avatar > Labs, you can find and enable Embedded HTML in markdown. After you do, you can edit the file and after committing changes, should no longer be displayed.

Please note that this feature is still in Beta, so there are some bugs related to it, e.g. https://jira.atlassian.com/browse/BCLOUD-20746.

Kind regards,
Theodora

You must be a registered user to add a comment. If you've already registered, sign in. Otherwise, register and sign in.

Comment

Thank you I will wait for the changes to come out of beta.

You must be a registered user to add a comment. If you've already registered, sign in. Otherwise, register and sign in.

Comment

Like • Theodora Boudale likes this

Was this helpful?

Thanks!

Bitbucket

Forums

Q&A

Community resources

Support

Top groups

Community resources

Support

Learn

Community resources

Support

Events

Community resources

Support

Why does Bitbucket render Markdown files (.md) file differently than CommonMark?

1 answer

1 accepted

Comments for this post are closed

Was this helpful?

Thanks!

TAGS

Atlassian Community Events