Adding relative links to screenshots in markdown files (like README.md) works way better at GitHub than on BitBucket:
- site / master / issues / #6589 – Markdown relative link to image and other readme does not work — Bitbucket.
- site / master / issues / #6315 – Relative urls in readme.md files only work half the time. BB-7521 — Bitbucket.
For GitHub, this works, has documentation and various places with tips:
- Relative links in READMEs · GitHub Help.
- How to add screenshot to READMEs in github repository ? – Stack Overflow.
In fact it is a reason for some people to move public projects from Bitbucket to GitHub.
For private repositories that is different as GitHub charges for private repositories, but BitBucket has free private repositories.
Note: if you go the npm way, then you might want to have absolute URLs: Add images to readme.md in GitHub – Stack Overflow.
–jeroen
via: git – How to add screenshot to READMEs in github repository ? – Stack Overflow.