yuring
Документация

Документация

Как поставить сайт в кольцо, как вставить виджет, как считаются баллы и переходы — и что можно делать с открытым API.

Быстрый старт

От нуля до сайта в кольце — четыре шага и пара минут.

Войди через Telegram — пароль не нужен.
Добавь сайт: название, адрес, описание, теги. Фавикон подтянется сам.
Поставь на свой сайт виджет или хотя бы две ссылки: prev и next.
Дождись подтверждения — обычно это несколько минут.

Виджет для сайта

Одна строка кода. Тёмная или светлая тема, три размера.

<youring-ring site="твой-slug" mode="pill"></youring-ring> <script src="https://youring.roxera.net/widget.js" async></script>

Три режима

  • pill — pill — компактная пилюля: имя сайта, брендовая точка и стрелки prev/next.
  • card — card — карточка 280px с превью, описанием и ссылками.
  • minimal — minimal — только имя и стрелки, без лишнего.

Атрибуты

  • site — site — короткая ссылка сайта. Без него виджет найдёт сайт по домену страницы.
  • mode — mode — pill (по умолчанию), card или minimal.
  • theme — theme — auto (по умолчанию), dark или light.
  • kind — kind — листать только это подкольцо по категории (личный сайт, блог, инструмент...).

Тёмная и светлая тема подхватываются автоматически: auto следует за системой.

Без JS? Тогда просто две ссылки:

<a href="https://youring.roxera.net/твой-slug/prev">← prev</a> <a href="https://youring.roxera.net/твой-slug/next">next →</a>

Бейдж

youring
<a href="https://youring.roxera.net/твой-slug"><img src="https://youring.roxera.net/badge/твой-slug.svg" width="320" height="64" alt="youring"></a>

Правила

  1. Сайт твой: личный сайт, блог, проект, портфолио, вики. Не лендинг одной кнопки «купить».
  2. На сайте должна быть обратная ссылка на кольцо. Без неё кольцо рассыпается.
  3. 18+ можно, но должно быть помечено. Такие сайты размыты по умолчанию.
  4. Спам, мошенничество, вирусы, ненависть — вон. Возврат только через новую заявку.
  5. Адрес сайта меняется только через заявку админу.

Пожалуйста, сообщи: короткая жалоба помогает держать кольцо чистым. Жалоба →

Баллы

У каждого сайта есть оценка 0–100. Это не голосование, а здоровье карточки: чем полнее сайт и живее связь с кольцом, тем выше балл.

+40

Сайт отвечает на запрос — 40 баллов. 403 от Cloudflare считается живым.

+30

На странице найден виджет youring или ссылки кольца — 30 баллов.

+15

Ссылки кольца ведут туда, куда должны — 15 баллов.

+15

Профиль заполнен: имя, описание, теги, иконка — 15 баллов.

Классы: S ≥ 95 · A ≥ 80 · B ≥ 60 · C ≥ 40 · D ≥ 20 · F < 20.

Баллы видны в кабинете у каждого твоего сайта и определяют место в лидерборде. Лидеры →

Переходы

Переход — это клик по сайту через кольцо. Считается один раз за вход и суммируется по сайтам.

  • Переход по короткой ссылке /твой-slug и по /твой-slug/next, /prev, /random.
  • Клик по планете, карточке или кнопке виджета в кольце.
  • Повторные клики подряд с одного устройства не накручивают счётчик.

Кольцо как система

Живое кольцо — это не только prev/next. Вот что ещё умеет youring.

  • Обратная ссылка обязательна для топа — Если на сайте нет ссылки на кольцо (виджета или ссылок prev/next), сайт остаётся видимым и листается как обычно — но в топ по баллам не попадает. Так топ отражает реальную взаимность. /lead →
  • Одна подписка на все блоги — Страница /feed и OPML-бандл /api/v1/ring/opml собирают фиды всех участников: добавь один файл в RSS-ридер — и читаешь всё кольцо. /feed →
  • Карта-созвездие — На /map каждая звезда — сайт: тусклые линии показывают порядок кольца, яркие — реальные ссылки участников друг на друга. У сайтов без обратной ссылки — красная точка. /map →
  • Подкольца по категориям — На /kinds кольцо разбито по категориям, и каждую можно листать отдельно: добавь ?kind= к ссылкам prev/next или к виджету — и листаешь только своё подкольцо. /kinds →

API и доки

Открытый JSON API: кольцо, соседи, случайный сайт, статистика, здоровье. Живой генератор виджета в документации.

GET /api/v1/ring GET /api/v1/ring/{slug} GET /api/v1/ring/opml GET /api/v1/random GET /api/v1/search?q=... GET /api/v1/stats GET /api/v1/health GET /badge/{slug}.svg

Вопросы

Это бесплатно?

Да. Кольцо живёт на своём сервере, рекламы и платных тарифов нет.

Куда ставить виджет?

В любое место страницы, где уместны ссылки на соседей: футер, блок «друзья», сайдбар. Скрипт можно оставить с async.

А если у меня нет JavaScript?

Хватит двух обычных ссылок prev и next — они и есть кольцо. Виджет просто удобнее.

Можно несколько сайтов?

Да, сколько угодно. У каждого свой slug, виджет и баллы.

Как поменять адрес?

Только через заявку админу из кабинета: адрес проверяется вручную, чтобы кольцо не ломали.

Как выйти из кольца?

Мгновенно, кнопкой в кабинете. Возврат — снова через заявку.

Нашёл спам или плохой сайт?

Пожалуйста, сообщи: короткая жалоба помогает держать кольцо чистым.

Полезные ссылки

Хочешь добавить свой сайт?

Поставь свой сайт в кольцо — и ходи по чужим в один клик.

Добавить свой сайт