Add images to README.md on BitBucket

Danny Dan picture Danny Dan · Feb 27, 2015 · Viewed 25.4k times · Source

Can I somehow reference the image from readme.md file so that it renders when viewed in BitBucket directly from project (without hosting the image elsewhere on web) ?

UPDATE:

The issue was resolved so it's working now as it was explained in the question:

I have stored readme.md file and an image file in a BitBucket repo as follows:

  • readme.md
  • images/
    • scheme.jpg

I reference the image from readme.md as follows:

![Scheme](images/scheme.jpg)

Answer

nwinkler picture nwinkler · Feb 27, 2015

Update 2016-12-14

This is fixed now, please see the resolved status of this issue: https://bitbucket.org/site/master/issues/6315/relative-urls-in-readmemd-files-only-work

You can now use

![Scheme](images/scheme.jpg)

to refer to images in your repo using relative links.

Old Answer

At the moment, this is not possible. BitBucket does not support relative links to images in markdown.

The following issue in BitBucket's issue tracker has more info on this, its current status (2015-02-27) is open: https://bitbucket.org/site/master/issue/6315/relative-urls-in-readmemd-files-only-work

The BitBucket team have indicated on the ticket that they intend to fix this "in the coming quarters" (comment from 2014-12-19: https://bitbucket.org/site/master/issue/6315/relative-urls-in-readmemd-files-only-work#comment-14400835).

The ticket contains a couple of (ugly) workarounds, using a combination of two links, where one works locally, and one on the web site (https://bitbucket.org/site/master/issue/6315/relative-urls-in-readmemd-files-only-work#comment-15852315) as well as some other possible solutions, none of which are particularly nice or reliable.