Images and embeds

How we add images and embeds to D-Sports docs. Store assets in /images.

D-Sports docs store images in the images folder (e.g. /images/og-image.png). Use root-relative paths and keep files under 5MB; for larger assets, use an external URL.

Image

Using Markdown

The markdown syntax lets you add images using the following code

![title](/path/image.jpg)

Note that the image file size must be less than 5MB. Otherwise, we recommend hosting on a service like Cloudinary or S3. You can then use that URL and embed.

Using embeds

To get more customizability with images, you can also use embeds to add images

<img height="200" src="/path/image.jpg" />

Embeds and HTML elements

D-Sports docs support HTML in Markdown (e.g. for images with custom styling). Use root-relative paths like /images/og-image.png for assets in this repo.

iFrames

Loads another HTML page within the document. Most commonly used for embedding videos.

<iframe src="https://www.youtube.com/embed/4KzFe50RQkQ"> </iframe>