Ограничения

Эта статья описывает ограничения однофайловой документации, которые важно учитывать при публикации и локальном открытии HTML-файла.

Внешние видео

Если в документ встроено YouTube- или Vimeo-видео, оно остается внешним элементом и не становится частью HTML-файла. Обычно такой плеер работает, когда документация открывается с сервера по http или https, но в локальном файле, открытом напрямую с диска, видео может не загрузиться.

Если важно, чтобы документ оставался удобным и в локальном виде, лучше вставить изображение-превью и открывать само видео на YouTube в новой вкладке. Такой вариант надежнее работает и в опубликованной версии, и в файле, который пользователь открыл у себя на компьютере.

Внешние скрипты и счетчики

Интеграции вроде Google Analytics, Яндекс Метрики и Webvisor загружаются со сторонних доменов. В локальном HTML такие счетчики могут не загрузиться, работать частично или вообще не отправлять события. Поэтому на полноценную аналитику стоит рассчитывать только в опубликованной версии документации.

Интернет-зависимые виджеты

Любые внешние iframe, support-chat, формы сторонних сервисов и другие embed-виджеты зависят от загрузки внешнего кода. В офлайн-режиме такие блоки могут не открываться, отображаться пустыми или ломать ожидаемый сценарий страницы. Для важных мест лучше заранее предусматривать запасной текст, прямую ссылку на внешний ресурс или статичную замену.

Локальный файл и политика браузера

Браузеры ограничивают часть возможностей у HTML-файлов, открытых напрямую через file://. Из-за этого некоторые внешние подключения, встроенные сервисы и сценарии, связанные с сетью, работают хуже, чем на обычном сайте. Итоговый документ лучше проверять в двух режимах: как локальный файл и как опубликованную страницу на сервере.

Офлайн-режим подходит не для всего

Основная структура документа, навигация, встроенные стили, скрипты и изображения могут работать офлайн, но не все виды контента одинаково автономны. Текстовая документация, инструкции, встроенные изображения и большая часть локальной логики обычно доступны без сети, а внешние медиа и сервисы могут требовать интернет и серверное размещение.

Если документ должен гарантированно открываться без подключения к сети, лучше делать упор на текст, изображения и встроенные элементы, а внешние зависимости использовать только как дополнительный слой.