CodeCommit Embedded Image in README

Question

I would like to include an image in a CodeCommit repository README file, located within the same repository. As opposed to other git providers, CodeCommit does not seem to support displaying those images to the user, instead it defaults to only displaying a link to the image. According to this post (https://stackoverflow.com/questions/52282347/aws-codecommit-markdown-embedded-pictures-images), this feature may have been discussed in 2018 in the context of the team's development roadmap, is this feature expected to be implemented soon? This is impacting our ability to provide high quality documentation to our users.

Thanks!

Answer

Hello there,

Greetings for the day!

Thanks for reaching out to us.

I see that you want to include an image in a CodeCommit repository README file but CodeCommit is not supporting this option. You want to know if this feature is expected to be implemented soon?

At this moment the feature is stilling development stage and the internal team is working on it. As the feature is in development state, we cannot comment on the ETA for it to go live at this moment. I went through couple of internal feature requests and found one on the [github](https://github.com/aws-samples/aws-codecommit-pull-request-aws-codebuild/issues/3) roadmap as well. You can directly converse with the internal team on it.

I hope this information helps. If you have any other concern or query, please feel free to reach back to us.

Answer

We have fixed markdown images to work from external sources and internal (relative repo paths) to work. Customers can use sub1/sub2/file.png for image under the current directory
../../test-image-1.png for images in a folder that above this one
../../img/test-image-2.png for images that are in another folder and not in this subtree

CodeCommit Embedded Image in README

관련 콘텐츠