Медиа
Изображения
Важно
Изображения должны храниться в каталоге, имя которого начинается с символа _
, иначе они будут удалены при сборке.
Стандартная разметка для вставки изображения имеет вид:
![alt-текст](_images/image.png "текст_подсказки" =100x100)
-
alt-текст
— название изображения, задается автором. В сборке не отображается. -
_images/image.png
— URL или путь до файла изображения. -
"текст_подсказки"
— подсказка, которая будет отображаться при наведении на изображение. Необязательный параметр. -
=100x100
— размер изображения. Необязательный параметр.Совет
Если вы хотите сохранить оригинальное соотношение сторон изображения, укажите только его ширину:
=100x
.
Изображение-ссылка
Вы можете сделать изображение кликабельным, используя правила оформления ссылок. Для этого добавьте стандартную разметку изображения в ту часть, которая предназначена для указания текста ссылки.
[![An old rock in the desert](../_images/mountain.jpg "Mountain" =100x200)](https://yandex.com/images/search?text=mountain)
Результат:
Reference-style разметка для изображений
Аналогично reference-style ссылкам, вы можете один раз объявить изображение в специальном месте, а в остальном документе обращаться к нему по метке. Это позволит использовать изображение несколько раз, не перегружая текст длинными URL или другими параметрами.
![An old rock in the desert][image1]
[image1]: ../_images/mountain.jpg "Mountain"
Результат:
Видео
Примечание
Поддерживаемый список видеохостингов: Yandex, Rutube, VK, Youtube, Vimeo, Vine, Osf, Prezi.
Если ваш видеохостинг не поддерживается, но у него есть кнопка экспорта видео, то воспользуйтесь разделом Видео из другого видеохостинга.
Видео из поддерживаемого видеохостинга
-
Чтобы добавить на страницу видео, используйте разметку:
@[название_хостинга](id_видео_или_ссылка_на_него)
-
Замените
название_хостинга
на название видеохостинга из списка:yandex
,rutube
,vk
,youtube
,vimeo
,vine
,osf
,prezi
. -
Откройте страницу с видео, которое нужно встроить в документацию.
-
Найдите код для публикации видео (код можно найти при экспорте в теге
iframe
, например, в разделе «Поделиться»).<iframe src="https://vk.com/video_ext.php?oid=-207738372&id=456239060&hd=2&autoplay=1" width="853" height="480" allow="autoplay; encrypted-media; fullscreen; picture-in-picture; screen-wake-lock;" frameborder="0" allowfullscreen></iframe>
-
Замените
id_видео_или_ссылка_на_него
на ссылку из атрибутаsrc
.
Пример разметки:
@[vk](https://vk.com/video_ext.php?oid=-207738372&id=456239060&hd=2&autoplay=1)
Результат:
Внимание
Если видео не отображается, и окно проигрывателя выдает ошибку ERR_BLOCKED_BY_CSP
:
1. Откройте .yfm
файл конфигурации.
2. Добавьте видеохостинг в список разрешенных доменов.
resources:
csp:
- "frame-src":
- "ссылка_на_видеохостинг"
Пример конфига
allowHTML: true
langs: ['en','ru']
resources:
csp:
- "frame-src":
- "https://vk.com"
- "https://login.vk.com"
- "https://runtime.strm.yandex.ru"
docs-viewer:
project-name: diplodoc
langs: ['en','ru']
...
Видео из другого видеохостинга
-
Чтобы добавить на страницу видео, используйте разметку:
@[](id_видео_или_ссылка_на_него)
-
Получите ссылку на видео.
-
Замените
id_видео_или_ссылка_на_него
на полученную ссылку.
Пример разметки:
@[](https://frontend.vh.yandex.ru/runtime/player/video/vplvic7jsotpobyc7o5b?autoplay=0&branding=0&from=documentation&mute=0&redirect_from=ugc)
Результат: