@giscusgiscus

giscus

Система за коментари, базирана на GitHub Discussions. Позволете на посетителите да оставят коментари и реакции на вашия уебсайт чрез GitHub! Силно вдъхновена от utterances.

Забележка
giscus все още е в активна разработка. GitHub също активно разработва Discussions и неговото API. Следователно някои функции на giscus може да се променят или да спрат да работят с времето.

Как работи

Когато giscus се зареди, GitHub Discussions API за търсене се използва за намиране на дискусията, свързана със страницата, въз основа на избрано съответствие (URL, pathname, <title> и т.н.). Ако не може да бъде намерена съответстваща дискусия, ботът на giscus автоматично ще създаде дискусия при първия път, когато някой остави коментар или реакция.

За да коментират, посетителите трябва да разрешат на приложението giscus да публикува от тяхно име, използвайки GitHub OAuth процеса. Алтернативно, посетителите могат да коментират директно в GitHub дискусията. Можете да модерирате коментарите в GitHub.

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

Език

Изберете езика, на който ще се показва giscus. Не намирате вашия език? Допринесете с локализация.

Хранилище

Изберете хранилището, към което giscus ще се свърже. Уверете се, че:

  1. Хранилището е публично, в противен случай посетителите няма да могат да виждат дискусията.
  2. Приложението giscus е инсталирано, в противен случай посетителите няма да могат да коментират и реагират.
  3. Функцията за дискусии е включена чрез активирането ѝ за вашето хранилище.

Публично GitHub хранилище. Това е хранилището, към което ще бъдат свързани дискусиите.

Съпоставяне на Страница ↔️ Дискусии

Изберете съпоставянето между вградената страница и вградената дискусия.

giscus ще търси дискусия, чието заглавие съдържа компонента pathname от URL адреса на страницата.

giscus ще търси дискусия, чието заглавие съдържа URL адреса на страницата.

giscus ще търси дискусия, чието заглавие съдържа HTML тага <title> на страницата.

giscus ще търси дискусия, чието заглавие съдържа HTML тага <meta property="og:title"> на страницата.

giscus ще търси дискусия, чието заглавие съдържа определен термин.

giscus ще зареди конкретна дискусия по номер. Тази опция не поддържа автоматично създаване на дискусии.

Избягвайте несъответствия поради приблизителния метод на търсене на GitHub, когато има няколко дискусии с подобни заглавия. Вижте документацията за повече подробности.

Категория на дискусията

Изберете категорията на дискусията, в която ще се създават нови дискусии. Препоръчително е да използвате категория от тип Announcements, така че нови дискусии да могат да се създават само от поддържащите и giscus.

При търсене на съответстваща дискусия, giscus ще търси само в тази категория.

Функции

Изберете дали определени функции трябва да бъдат активирани.

Реакциите за основната публикация на дискусията ще се показват преди коментарите.

Метаданните за дискусията ще се изпращат периодично към родителския прозорец (вградената страница). За демонстрация активирайте тази опция и отворете конзолата на браузъра на тази страница. Вижте документацията за повече подробности.

Полето за въвеждане на коментари ще бъде поставено над коментарите, така че потребителите да могат да оставят коментар без да превъртат до края на дискусията.

Зареждането на коментарите ще бъде отложено, докато потребителят не превърти близо до контейнера с коментари. Това се постига чрез добавяне на loading="lazy" към елемента <iframe>.

Тема

Изберете тема, която съответства на вашия уебсайт. Не намирате подходяща? Допринесете с нова тема.

Активиране на giscus

Добавете следния таг <script> към шаблона на вашия уебсайт, където искате да се появят коментарите. Ако съществува елемент с клас giscus, коментарите ще бъдат поставени там.

Не сте конфигурирали вашето хранилище и/или категория. Стойностите за тези полета няма да се покажат, докато не ги попълните.
<script src="https://giscus.app/client.js"
        data-repo="[ВЪВЕДЕТЕ ХРАНИЛИЩЕ ТУК]"
        data-repo-id="[ВЪВЕДЕТЕ ID НА ХРАНИЛИЩЕ ТУК]"
        data-category="[ВЪВЕДЕТЕ ИМЕ НА КАТЕГОРИЯ ТУК]"
        data-category-id="[ВЪВЕДЕТЕ 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="bg"
        crossorigin="anonymous"
        async>
</script>

Можете да персонализирате оформлението на контейнера с помощта на селекторите .giscus и .giscus-frame от вградената страница.

Ако използвате giscus, обмислете да дадете звезда 🌟 на giscus в GitHub и да добавите темата giscus към вашето хранилище! 🎉

Разширена употреба

Можете да добавите допълнителни конфигурации (напр. разрешаване на специфични origins), като следвате ръководството за разширена употреба.

За да използвате giscus с React, Vue или Svelte, вижте библиотеката с компоненти на giscus.

Мигриране

Ако преди сте използвали други системи, които използват GitHub Issues (напр. utterances, gitalk), можете да конвертирате съществуващите issues в дискусии. След конвертирането просто се уверете, че съответствието между заглавията на дискусиите и страниците е правилно, и giscus автоматично ще използва дискусиите.

Сайтове използващи giscus

Допринасяне

Вижте CONTRIBUTING.md

Изпробвайте 👇👇👇

Powered by Vercel