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

katie.shakman
katie.shakman Administrator, Domino Posts: 257 admin

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")

Thanks @aaron.gruberg for the example.

Katie

Field Data Scientist @ Domino

Comments

  • alex.lentz
    alex.lentz Member Posts: 1

    Is there a way to resize the image?

    Thanks,

    Alex

  • andrew.coleman
    andrew.coleman Member, Moderator, Domino Posts: 5 mod
    edited April 2020

    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!

    Andrew

    Field Engineer @ Domino

  • katie.shakman
    katie.shakman Administrator, Domino Posts: 257 admin

    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.

    Katie

    Field Data Scientist @ Domino

Sign In or Register to comment.

Howdy, Stranger!

It looks like you're new here. If you want to get involved, click one of these buttons!