@giscusgiscus

giscus

Systém komentářů založený na GitHub Discussions. Nechte návštěvníky zanechávat komentáře a reakce na vašem webu prostřednictvím GitHub! Silně inspirováno utterances.

Poznámka
giscus je stále ve fázi aktivního vývoje. GitHub také stále aktivně vyvíjí Discussions a jeho API. Některé funkce giscusu se tedy mohou časem rozbít nebo změnit.

Jak to funguje

Při načtení nástroje giscus se použije GitHub Discussions search API k vyhledání diskuse spojené se stránkou na základě zvoleného mapování (URL, pathname, <title> atd.). Pokud odpovídající diskusi nenajde, giscus bot automaticky vytvoří diskusi, jakmile někdo poprvé zanechá komentář nebo reakci.

Aby mohli návštěvníci komentovat, musí autorizovat aplikaci giscus, aby psala jejich jménem pomocí GitHub OAuth. Případně mohou návštěvníci komentovat přímo v GitHub Discussion. Komentáře můžete moderovat na GitHub.

Konfigurace

Jazyk

Zvolte jazyk, ve kterém bude giscus zobrazen. Chybí váš jazyk? Přispějte k lokalizaci.

Repozitář

Vyberte repozitář, ke kterému se giscus připojí. Ujistěte se, že:

  1. Repozitář je veřejný, jinak návštěvníci nebudou moci zobrazit diskusi.
  2. Aplikace giscus je nainstalována, jinak návštěvníci nebudou moci komentovat a reagovat.
  3. Funkce Discussions je zapnuta v nastavení vašeho repozitáře.

Veřejný repozitář na GitHub. Tento repozitář je místem, ke kterému budou diskuse připojeny.

Mapování: Stránka ↔ Diskuse

Zvolte mapování mezi stránkou, do které se diskuse vkládá, a samotnou diskusí.

giscus bude hledat diskusi, jejíž název obsahuje komponentu pathname URL adresy stránky.

giscus bude hledat diskusi, jejíž název obsahuje URL adresu stránky.

giscus bude hledat diskusi, jejíž název obsahuje text HTML tagu <title> stránky.

giscus bude hledat diskusi, jejíž název obsahuje text HTML značky <meta property="og:title"> stránky.

giscus bude hledat diskusi, jejíž název obsahuje konkrétní výraz.

giscus načte konkrétní diskusi podle čísla. Tato možnost nepodporuje automatické vytvoření diskuse.

Při vyhledávání se vyhněte nesprávným shodám způsobeným nepřesným vyhledáváním na GitHub, pokud existuje více diskusí s podobnými názvy. Další podrobnosti naleznete v dokumentaci.

Kategorie diskuse

Vyberte kategorii diskuse, ve které budou vytvořeny nové diskuse. Doporučuje se použít kategorii typu Oznámení (Announcements), aby nové diskuse mohli vytvářet pouze správci a giscus.

Při hledání odpovídající diskuse bude giscus hledat pouze v této kategorii.

Funkce

Zvolte, zda mají být určité funkce povoleny.

Reakce na hlavní příspěvek diskuse budou zobrazeny před komentáři.

Diskusní metadata budou pravidelně odesílána do nadřazeného okna (stránky, do které je giscus vložen). Pro ukázku povolte tuto funkci a otevřete konzoli prohlížeče na této stránce. Další podrobnosti naleznete v dokumentaci.

Okno pro zadávání komentářů bude umístěno nad komentáři, aby uživatelé mohli přidat komentář bez nutnosti posouvání na konec diskuse.

Načítání komentářů se odloží, dokud uživatel nescrolluje blízko kontejneru s komentáři. Toho se dosáhne přidáním atributu loading="lazy" do <iframe>.

Barevné schéma

Vyberte barevné schéma, které odpovídá vašemu webu. Nemůžete najít žádné, které by vyhovovalo? Přispějte novým barevným schématem.

Povolit giscus

Přidejte následující <script> tag do šablony vašeho webu na místo, kde chcete zobrazit komentáře. Pokud existuje prvek s třídou giscus, komentáře budou umístěny tam.

Nemáte nakonfigurovaný svůj repozitář a/nebo kategorii. Hodnoty těchto polí se nezobrazí, dokud je nevyplníte.
<script src="https://giscus.app/client.js"
        data-repo="[ZDE ZADEJTE JMÉNO REPOZITÁŘE]"
        data-repo-id="[ZDE ZADEJTE ID REPOZITÁŘE]"
        data-category="[ZDE ZADEJTE JMÉNO KATEGORIE]"
        data-category-id="[ZDE ZADEJTE ID KATEGORIE]"
        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="cs"
        crossorigin="anonymous"
        async>
</script>

Rozložení kontejneru lze upravit pomocí selektorů .giscus a .giscus-frame na stránce, která komponentu giscus vkládá.

Pokud používáte giscus, zvažte zahvězdičkování 🌟 giscus na GitHub a přidání tématu giscus do svého repozitáře! 🎉

Pokročilé použití

Další konfigurace (např. povolení konkrétních domén) můžete přidat podle průvodce pokročilým použitím.

Chcete-li používat giscus s React, Vue nebo Svelte, podívejte se na knihovnu komponent giscus.

Migrace

Pokud jste dříve používali jiné systémy, které využívají GitHub Issues (např. utterances, gitalk), můžete převést stávající issues na discussions. Po převodu se jen ujistěte, že mapování mezi názvy diskusí a stránkami je správné, pak bude giscus automaticky používat Discussions.

Stránky používající giscus

Přispívání

Viz CONTRIBUTING.md

Vyzkoušejte to 👇👇👇

Powered by Vercel