Reference pictures from markdown files
The most natural way of working with pictures in markdown files is to put them in a /media folder. The media folder must exists just on below the docs folder, ie docs/media.
There can be multiple folders inside the media folder if convenient. As an example, for the pictures used in developers folder, the pictures resides in docs/media/developers. There can only one media folder below the docs folder.
Example of referencing a picture in a markdown file:
The nice thing about this approach, is that you can preview the picture in your markdown editor, like VS code, when working locally before pushing to the documentation repo.
Reference pictures with external links from markdown files
Pictures can also be referenced from external links. If you need a place to store the, then the suggested place is Norsk Helsenett space on github (https://github.com/NorskHelsenett/shp-developerportal).
Make an dedicated folder for your service and use the same name as your service on Developer portal. Then upload the files there. Find the file by and choose "Open image in new tab". Then go to that tab and copy the absolute adress. Make sure you can reach the file by test in in an inconito brower window.
Then, when referencing the files, use the following syntax:
![Text][<absolute path to file>]
Example:
![Text][https://raw.githubusercontent.com/NorskHelsenett/shp-developerportal/main/plattform-utviklerportal/developer/helsegitlab-web-ide.png]
How to reference pictures in a markdown file
You can put pictures in the docs repo, and they will be synced in. That can be useful in some cases. These files will be imported into the media part of Umbraco and will be showed as a standalone file in the imported docs repo.
Supported file formats
Supported file formats for pictures are jpg, svg and png.