Adding a video to Reference docs

Redocly enables you to add/embed an external video in your documentation. This page describes how to add a video from an external source (YouTube, Loom etc) to your reference docs.

Note: You can add a video to any Markdown pages that are referenced in your OpenAPI definition, but you cannot add a video directly to the API definition file.

Prerequisites

You will need the embed code from YouTube (or other sources like Loom). For more information on how to retrieve:

Add a video to your reference docs

  1. Open the Markdown page where you want to add the video in the reference docs. For an OpenAPI document, you can also edit the relevant Markdown supported description property with the embed code.
  2. Copy the embed code for the video from YouTube (or other sources).
  3. Add the following text in your Markdown page where you want to add the video:
# Embedded video

<iframe width="560" height="315" src="<**your video embed code**>" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>

Note: You can edit video properties as required, including width and height properties. Redocly supports all standard iframe attributes.

Example - Embedded video

To see an example of how the video is rendered in the reference docs, refer to the Redocly embedded video demo.