Videos

Table of contents

Video guidelines

Docker 文档中很少使用视频。如果使用，视频应作为书面文本的补充，而不应作为文档的唯一格式。与书面文本甚至截图相比，视频的制作时间更长，维护也更困难，因此在添加视频之前，请考虑以下几点：

如果满足以上所有标准，您可以在创建视频以添加到 Docker 文档之前，参考以下最佳实践。

确定视频的目标受众。视频是为初学者提供的广泛概述，还是为高级用户设计的深入技术流程讲解？
视频时长应少于 5 分钟。请考虑视频需要多长时间才能恰当地解释主题，如果视频需要超过 5 分钟，请考虑使用文本、图表或截图代替。这些形式更便于用户扫描以查找相关信息。
视频应遵守与文档其余部分相同的可访问性标准。
通过编写脚本（如果有旁白）、确保不显示多个浏览器和 URL、模糊或裁剪掉任何敏感信息，以及在不同浏览器或屏幕之间使用平滑过渡，来确保视频质量。

视频不托管在 Docker 文档仓库中。要添加视频，您可以链接到托管的内容，或使用 iframe 进行嵌入。

要在文档页面上嵌入视频，请使用 <iframe> 元素：

<iframe
  class="border-0 w-full aspect-video mb-8"
  allow="fullscreen"
  title=""
  src=""
  ></iframe>

asciinema 是一个用于录制终端会话的命令行工具。这些录制内容可以嵌入到文档网站上。它们类似于 console 代码块，但由于它们是可播放和可拖动的视频，在某些情况下比静态代码块更有用。asciinema "视频"中的文本也可以被复制，这使得它们更加实用。

在以下情况下考虑使用 asciinema 录制：

要创建 asciinema 录制并将其添加到文档中：