Images
3 min
Image blocks help illustrate concepts, provide visual context, and make documentation easier to follow. You can add images to your documents using standard Markdown syntax.
Syntax
Images use standard Markdown syntax.
The text inside the square brackets is used as the image's alternative text, which improves accessibility and provides context if the image cannot be displayed.
Image settings
Standard Markdown holds only the image address, its alternative text and a caption. When an image has other settings, such as a size, a left or right alignment, a dark-mode version or a link, Git Sync writes it as an Image component.
::Image[]{src="https://example.com/diagram.png" alt="Diagram" darkSrc="https://example.com/diagram-dark.png" position="flex-start"}- darkSrc is the image shown in dark mode.
- position aligns the image: flex-start for left, center, or flex-end for right.
- size is the image width as a percentage of the content width, such as 50.
Example
The following example adds an image to a document.
