Документация исходного кода; установленный выпуск может отличаться.
Поддержка сайта документации
Сайт проекта — статические файлы в docs/. В GitHub Pages нужно выбрать Deploy from a branch → main → /docs. Файл .nojekyll указывает Pages отдавать сохранённый HTML напрямую. Отдельный хостинг и сервер приложения не нужны.
Правки и сборка
Порядок снимков и двуязычные подписи каруселей находятся в scripts/site/showcase.mjs. Оригиналы и сведения о съёмке — в images/pc/, images/mobile/ и images/README.md. Генератор копирует каждый снимок в docs/media/. Карусели листаются вручную, стрелками и с клавиатуры; снимки открываются в диалоге увеличения. Автопрокрутки нет. В GitHub README используются совместимые Markdown-галереи со ссылкой на полные карусели. Страница поддержки Tribute: https://web.tribute.tg/d/Sh6.
Исходником руководств остаётся Markdown. Двуязычные тексты главной страницы находятся в scripts/site/content.mjs, разметка — в scripts/site/layout.mjs. Локальные стили и браузерные взаимодействия — в docs/assets/. Используются системные шрифты, без сервиса шрифтов, аналитики и CDN.
После изменения зависимостей выполните npm ci, затем:
node scripts/build-docs-site.mjs
node scripts/check-docs-site.mjs
node scripts/test-docs-site.mjs
Генератор использует Marked (MIT), закреплённую зависимость разработки. Он формирует HTML в docs/read/, копирует локальные изображения и собирает двуязычный поисковый индекс. Сырой HTML экранируется, протоколы ссылок ограничены. В браузер посетителя не загружается сторонний рендерер.
Помещайте локальные изображения в публичные папки images/, docs/assets/ или docs/media/. Поддерживаются PNG, JPEG, GIF, WebP, SVG, AVIF, BMP и ICO. Скрытые файлы и другие каталоги проекта не копируются как изображения; реальная цель символической ссылки должна соответствовать тем же правилам. Генератор также запрещает чтение и запись результатов за пределами репозитория.
Исходниками Markdown могут быть только объявленные публичные руководства. Скрытые Markdown-файлы и ссылки руководств на необъявленные приватные файлы отклоняются до чтения содержимого.
Сохраняйте с изменениями исходников обновлённые HTML и индекс. Проверка выявляет устаревший результат, отсутствующие файлы, сломанные локальные якоря и изображения без альтернативного текста. CI и workflow выпуска проверяют сайт до публикации. DOM-тесты проверяют взаимодействия, но не заменяют визуальную проверку в настольном и мобильном браузере.
Просмотр и снимки
Команда npm version запускает version hook: обновляет метаданные плагина и пересобирает сайт перед
добавлением документации в индекс Git. После ручного изменения версии тоже нужны генератор и проверки.
Раздайте docs/ локальным HTTP-сервером и проверьте index.html и en.html: узкую и широкую раскладку, клавиатуру, поиск, примеры и уменьшенное движение. Нужны проверки как в корне сервера, так и с префиксом /obs-projects-plus/.
Пример на главной явно обозначен упрощённой интерактивной моделью, а не снимком плагина. Скриншоты продукта должны относиться к определённой сборке с демонстрационными заметками; сохраняйте сведения о версии, происхождении данных и среде съёмки. Не публикуйте личные хранилища и не выдавайте настольную эмуляцию за проверку iPhone.