Examples of images
This page contains a few images, mostly to test that the JavaScript that makes large image into links works properly.
Add an image in markdown
Add an image using the normal markdown syntax:
<br/>_Caption text_
For example:
<br/>_Twin cupolas in Puerto Vallarta, Mexico_
Which renders as:
Twin cupolas in Puerto Vallarta, Mexico
Images as links
If you need an image to also be a link, you can use inline html syntax. If you prefer to stick with markdown, you can actually put the markdown image syntax inside the markdown link syntax:
[](link-url)<br/>_Caption text_
For example:
[](https://www.unity3d.com)<br/>_A sailboat and a bird_
Which renders as:
A sailboat and a bird
Note
The image above is wider than the default large image threshold. However, Images that are already links don't have the zoom treatment applied to them.
Large images
The page layout of the package documentation has a restricted content width. While you should strive to keep your images as small as possible for readability and efficency reasons (but not too small), sometimes you must use a larger image. To save you the trouble of making images into links to themselves, the PMDT makes any images it finds that are larger than a specified threshold into a link that opens the image in a new browser tab or window. This threshold value is specified in the Per project Metadata.
An image that is 2509 pixels wide
An image that is 1200 pixels wide
Note that the maximum width of an image in the page layout is 800 pixels. Wider images are scaled to fit.