Articles in this section

See more

FAQ: How do I add an image to the README on my project overview page?

Katie
  • Updated
Follow

Here's an example of including a static image in your readme.md. You can include the image in the root of your /mnt folder and raw/latest should grab the latest version of that image.

![Title](raw/latest/filename.png?inline=true "Title")

Related articles

Comments

3 comments

Date Votes
  • Jaclyn Patterson

    Is there a way to resize the image?

    Thanks,

    Alex

    Submitted by: alex.lentz

    0
    Comment actions Permalink
  • Jaclyn Patterson

    Hi @alex.lentz - in order to edit the sizing of the image, you will have to use a slightly different annotation:

    <img src="raw/latest/filename.png?inline=true" title="Title" width="500">

    Where the width (and title) can be changed to whatever size you would like.

    Hope that helps!

    Submitted by: andrew.coleman

    0
    Comment actions Permalink
  • Jaclyn Patterson

    Side note: Admins can choose whether to allow HTML rendering in Markdown or not. If the ShortLived.ExecuteHtmlInMarkdown feature flag is set to False by the admin, then this approach to controlling images won't be allowed.

    Submitted by: katie.shakman

    0
    Comment actions Permalink

Please sign in to leave a comment.