Forums

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

How can I get a reliable Markdown preview?

Eric Barbosa
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!
October 31, 2022

Hi All,

I'm trying to update the README.md on our repo. The output I get in the repo is different from all the previews I have tested. I've tested various VSCode extensions and online Markdown editors.

Thanks in advance.

1 answer

1 vote
Theodora Boudale
Atlassian Team
Atlassian Team members are employees working across the company in a wide variety of roles.
November 1, 2022

Hi Eric and welcome to the community!

If you go to the Source page of the repo on Bitbucket Cloud website > select the README.md file > select Edit to edit the file, you will then see the option Preview next to the Commit button, at the bottom of the page:

Screenshot 2022-11-01 at 14.38.43.png


Please note that you need to make some edits in order for the Preview button to become enabled.

If you have some content that does not get formatted the way you expect it, please provide us with

  • some demo content (it doesn't have to be the actual text from your file, just some dummy text to demonstrate the issue)
  • some explanation of how you expect it to be formatted instead (you could also provide us with a link to an online markdown preview editor that formats it differently)

Kind regards,
Theodora

Eric Barbosa
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 1, 2022

Thanks for the reply.

I will create a screen cast of the and post it soon.

Theodora Boudale
Atlassian Team
Atlassian Team members are employees working across the company in a wide variety of roles.
November 2, 2022

You are welcome Eric, please feel free to post it when you can.

Suggest an answer

Log in or Sign up to answer
DEPLOYMENT TYPE
CLOUD
PERMISSIONS LEVEL
Product Admin
TAGS
AUG Leaders

Atlassian Community Events