Документация (README) для плагинов Grav: VkFeedPlugin, Html5VideoPlugin и Mp3AudioPlugin
VkFeedPlugin
Назначение
Скачать https://rksband.ru/user/pages/instrukciya-dlya-plaginov/vkfeed.zip
Плагин для интеграции и отображения новостной ленты из ВКонтакте на сайте Grav через вставку простого div с параметрами.
Установка
- Разместите папку плагина в
user/plugins/vkfeed - Активируйте плагин в конфигурации Grav
Использование
В коде страницы вставьте тег:
<div id="vkfeed" data-owner="89807929" data-count="10"></div>где:
data-owner— ID сообщества ВКонтакте (со знаком минус)data-count— количество отображаемых постов
Плагин на стороне сервера подгружает посты VK, кеширует и рендерит их с поддержкой изображений, видео и модального окна.
Конфигурация
plugins/vkfeed/vkfeed.yamlapi_token: VK API токен для доступа к APIttl: Время кеширования в секундах
Особенности
- Вынесенный CSS в отдельный файл
vkfeed.css - Адаптивное отображение изображений (с сохранением пропорций)
- Видео с превью и воспроизведением по клику в модальном окне
- Кеширование постов для оптимизации загрузки
Html5VideoPlugin
Назначение
Скачать https://rksband.ru/user/pages/instrukciya-dlya-plaginov/html5video.zip
Плагин для удобного вставления html5 видео с кастомным плейером и модальным полноэкранным просмотром.
Установка
- Положите плагин в
user/plugins/html5video - Включите плагин через админку или config
Использование
В тексте страницы вставьте:
<div class="html5-video">/путь/к/видео.mp4, Заголовок видео, /путь/к/постеру.jpg</div>- Параметры:
- Путь к видео (обязательный)
- Заголовок видео (обязательный)
- Путь к постеру (необязательный)
Особенности
- Вынесенный CSS в
html5video.css, подгружаемый автоматически - Плэйер со стильным кастомным интерфейсом
- Модальное окно с полноэкранным видео и кнопкой закрытия
- Обработка кликов и Esc для удобного управления
Mp3AudioPlugin
Назначение
Скачать https://rksband.ru/user/pages/instrukciya-dlya-plaginov/mp3audio.zip
Плагин для вставки одиночных mp3 аудиоплееров и плейлистов с последовательным воспроизведением и динамическими обложками.
Установка
- Поместите плагин в
user/plugins/mp3audio - Включите в конфигурации Grav
Использование
Одиночный трек:
<div class="mp3-audio">/путь/к/треку.mp3, Название трека, /путь/к/обложке.jpg</div>Обложка и обрезка опциональны.
Плейлист:
<div class="mp3-audio">
/путь/к/треку1.mp3, Название 1, /путь/к/обложке1.jpg
/путь/к/треку2.mp3, Название 2
/путь/к/треку3.mp3, Название 3, путь/к/обложке3.jpg
</div>Каждый трек с новой строки, третья часть — необязательная обложка.
Особенности
- Поддержка темного полупрозрачного стиля (
mp3audio.css) - Воспроизведение по клику на трек с отображением обложки 256x256 пикселей вместо иконки
- Последовательный проигрыш треков в плейлисте
- Одинаковое поведение одиночных плееров и плейлистов
- Подгрузка css из
mp3audio.cssили встроенный дефолтный стиль
Общие рекомендации
- Вся стилизация выделена в файлы CSS в корнях плагинов (vkfeed.css, html5video.css, mp3audio.css)
- Плагины внедряют стили прямо в
<head>страницы автоматически. - Используйте корректный синтаксис вставки для каждого плагина, чтобы обеспечить правильный вывод и функциональность.
- Все API и ключи настраиваются через конфигурационные файлы плагинов.