mirror of
https://github.com/LightAir/turbo-rss.git
synced 2026-02-04 03:56:19 +00:00
Рефакторинг. Дорабавление новых опций.
This commit is contained in:
14
readme.md
14
readme.md
@@ -35,24 +35,34 @@ feed.item(itemOptions);
|
||||
##### itemOptions
|
||||
|
||||
* `title` **string** Заголовок страницы.
|
||||
* `subheading` _optional_ **string** Подзаголовок страницы.
|
||||
* `image_url` _optional_ **url string** Адрес изображения, которое используется в качестве обложки. Изображение может быть в любом формате.
|
||||
* `image_caption` _optional_ **string** Подпись к изображению обложки.
|
||||
* `link` **url string** URL страницы сайта, для которой нужно сформировать Турбо-страницу.
|
||||
* `author` _optional_ **string** Автор статьи, размещенной на странице.
|
||||
* `date` или `pubDate` **string** Время публикации контента на сайте источника. Передается в формате RFC-822.
|
||||
* `content` **string** Содержимое страницы
|
||||
* `menu` _optional_ **array** Внимание! Меню будет отображаться только в том случае, если в настройках на странице Яндекс Вебмастер -> Турбо-страницы -> Настройки, содержимое 'Меню Турбо-страниц' пустое!
|
||||
* `breadcrumbs` _optional_ **array** Навигационная ссылка https://yandex.ru/dev/turbo/doc/rss/elements/header.html#breadcrumbs
|
||||
* `related` _optional_ **array** Аффилированные ссылки `yandex:related` в конце статьи. Вы можете разместить ссылки на другие ресурсы или настроить отображение непрерывной ленты статей, реализованной, например с помощью AJAX.
|
||||
* `relatedfinity` _optional_ **bool** Непрерывная лента статей
|
||||
* `relatednfinity` _optional_ **bool** Непрерывная лента статей (Параметр был переименован из relatedfinity)
|
||||
* `turboSource` _optional_ **string** URL страницы-источника, который можно передать в Яндекс.Метрику.
|
||||
* `turboTopic` _optional_ **string** Заголовок страницы, который можно передать в Яндекс.Метрику.
|
||||
* `goals` _optional_ **array** массив типа: { _id_ - внутренний идентификатор цели (turbo-goal-id), _name_ - имя цели, _counter_id_ - id счётчика яндекс-метрики }
|
||||
* `turboEnabled`_optional_ **bool** Принудительная установка атрибута "turbo". По умолчанию true. Установка в false позволит скрыть отображение турбо-страницы
|
||||
|
||||
###### menu array
|
||||
menu должен содержать массив объектов со следующими опциями:
|
||||
|
||||
* `link` **url string** ссылка
|
||||
* `text` **string** текст ссылки. не должен содержать html
|
||||
|
||||
|
||||
###### breadcrumbs array
|
||||
Один элемент хлебных крошек должен содержать массив объектов со следующими опциями:
|
||||
|
||||
* `link` **url string** ссылка
|
||||
* `text` **string** текст ссылки (не должен содержать html)
|
||||
|
||||
###### related array
|
||||
related должен содержать массив объектов со следующими опциями:
|
||||
|
||||
|
||||
Reference in New Issue
Block a user