@giscusgiscus

giscus

Система коментарів на основі GitHub Discussions.
Дає змогу користувачам залишати свої реакції та коментарі на сайті за допомогою GitHub! Основним чином розробка була натхненна системою коментарів utterances.

Note:
giscus знаходиться у фазі активної розробки. GitHub також активно розвиває Discussions та його API. Тому деякі можливості giscus можуть не працювати або з часом змінюватися.

Принцип роботи

Після завантаження giscus GitHub Discussions search API використовується для пошуку обговорень, зв'язаних із поточною сторінкою на основі вибраного типу зв'язку (URL, pathname, <title>, ітд.).
Якщо обговорення не було знайдене, то бот giscus автоматично створює нове обговорення, як тільки хтось створить перший коментар або реакцію.

Щоб додати новий коментар користувачі мусять пройти авторизацію giscus app для здійснення публікацій коментарів від свого імені за допомогою GitHub OAuth.
Крім того, користувачі можуть залишати коментарі напряму в GitHub Discussion. Ви можете проводити модерацію цих коментарів через GitHub.

Конфігурація

Мова

Оберіть мову giscus. Не можете знайти свою мову? Створіть переклад.

Репозиторій

Оберіть репозиторій, з яким з'єднається giscus. Упевніться що:

  1. Репозиторій публічний, інакше відвідувач не зможе переглянути обговорення.
  2. The Встановлено застосунок giscus, інакше відвідувачі не зможуть залишити коментар, або додати реакцію.
  3. Функція Discussions увімкнена за допомогою налаштувань репозиторію.

Публічний GitHub репозиторій. До цього репозиторію буде приєднано Discussions.

Сторінка ↔️ Обговорення

Оберіть спосіб поєднання сторінки сайту та обговорення до неї.

giscus шукатиме обговорення назва якого містить шлях до сторінки.

giscus шукатиме обговорення назва якого містить URL сторінки.

giscus шукатиме обговорення назва якого містить назву сторінки (HTML тег <title>).

giscus шукатиме обговорення назва якого містить <meta property="og:title"> сторінки.

giscus шукатиме обговорення назва якого містить спеціальне слово (term).

giscus шукатиме обговорення за номером (number). Ця опція не підтримує автоматичне створення обговорень.

Уникати незбіжності спричинені нечітким методом пошуку GitHub, коли декілька обговорень можуть мати однакову назву. Перегляньте документацію, щоб дізнатися більше.

Категорія обговорень

Оберіть категорію обговорень, в якій будуть створюватись нові обговорення. Рекомендовано використовувати категорію Announcements, оскільки тамошні обговорення можуть створювати лише власники репозиторію та застосунок giscus

Під час пошуку необхідного обговорення, giscus шукатиме лише в цій категорії.

Функції

Оберіть функції, які ви хочете увімкнути.

Реакції до обговорення будуть показані перед коментарями.

Метадані обговорення періодично відправляються до батьківського вікна (глобальний об'єкт допису). Для демонстрації роботи увімкніть цю опцію, та відкрийте консоль браузера на сторінці вашого допису. Перегляньте документацію, щоб дізнатися більше.

Поле вводу буде розташовано перед коментарями, таким чином відвідувач зможе залишити коментар не листаючи до низу.

Завантаження коментарів буде відкладено допоки відвідувач не дістанеться до блоку з коментарями. Така поведінка зумовлена додаванням loading="lazy" до <iframe> елементу.

Тема

Оберіть тему, що пасуватиме кольорам вашого сайту. Не можете знайти підхожий варіант? Додайте нову тему.

Увімкнути giscus

Додайте наступний тег <script> до шаблону вашого сайту, на якому ви хочете побачити коментарі. Якщо елемент з класом giscus вже існує, коментарі будуть вмонтовані всередині нього.

Ви не налаштували своє репозиторій та/або категорію. Значення цих полів не відображатимуться, доки ви їх не заповните.
<script src="https://giscus.app/client.js"
        data-repo="[ВВЕДІТЬ REPO]"
        data-repo-id="[ВВЕДІТЬ REPO ID]"
        data-category="[ВВЕДІТЬ CATEGORY NAME]"
        data-category-id="[ВВЕДІТЬ CATEGORY ID]"
        data-mapping="pathname"
        data-strict="0"
        data-reactions-enabled="1"
        data-emit-metadata="0"
        data-input-position="bottom"
        data-theme="preferred_color_scheme"
        data-lang="uk"
        crossorigin="anonymous"
        async>
</script>

Ви можете змінити вигляд контейнера за допомогою селекторів .giscus та .giscus-frame.

Якщо ви використовуєте giscus, поставте 🌟 giscus на GitHub будь ласка, та додайте giscus тег у ваш репозиторій! 🎉

Розширені налаштування

В giscus доступні розширені налаштування, такі як фільтрація по window.origin, ітд.

Для використання giscus із React, Vue, або Svelte зверніться до бібліотеки компонентів giscus.

Міграція

Якщо ви раніше користувалися іншими системами, котрі використовували GitHub Issues (наприклад, utterances, gitalk), ви можете сконверктувати існуючі запити в дискусії.
Після конвертації переконайтеся у відповідності між дискусіями та сторінками сайту, тоді giscus автоматично знайде та відобразить ці дискусії.

Сайти, котрі використовують giscus

Співпраця

Деталі: CONTRIBUTING.md

Спробувати 👇👇👇

Powered by Vercel