Egy hozzászólási rendszer, ami a GitHub Discussions adta lehetőségeket használja. Segítségével látogatóid hozzászólásokat és reakciókat hagyhatnak weboldaladon a GitHub által! Erősen inspirálta az utterances.
Megjegyzés
A giscus még aktív fejlesztés alatt áll. A GitHub is folyamatosan fejleszti a Discussions-t és annak API-ját. Így előfordulhat, hogy a giscus néhány funkciója idővel elromlik vagy megváltozik.
Hogyan működik
Amikor a giscus betöltődik, a GitHub Discussions keresési API használatával megkeresi az oldalhoz tartozó beszélgetést egy választott leképezés alapján (URL, pathname, <title>, stb.). Ha nem található egyező beszélgetés, a giscus bot automatikusan létrehoz egyet, amikor valaki először hagy egy hozzászólást vagy reakciót.
A hozzászóláshoz a látogatóknak engedélyezniük kell a giscus alkalmazást számára a GitHub OAuth folyamat segítségével, hogy a nevükben hozzászólhassanak. Alternatív megoldásként a látogatók közvetlenül a GitHubon is hozzászólhatnak. A hozzászólásokat a GitHubon moderálhatod.
Beállítások
Nyelv
Válaszd ki giscus megjelenítési nyelvét. Nem találod? Járulj hozzá a lokalizáció elkészítéséhez.
Repository
Válaszd ki, melyik repository-hoz kapcsolódjon a giscus. Győződj meg róla, hogy:
A repository nyilvános, különben a látogatók nem tudják megtekinteni a beszélgetést.
A giscus app telepítve van, különben a látogatók nem tudnak hozzászólni és reagálni.
Válaszd ki a beágyazott oldal és a beágyazott beszélgetés közötti leképezést.
A GitHub fuzzy keresési módszeréből adódó helytelen egyezések elkerülhetők szigorú egyezés használatával, ha több hasonló című beszélgetés van. További részletekért lásd a dokumentációt.
Beszélgetés kategóriája
Válaszd ki, milyen kategóriában jöjjenek létre az új beszélgetések. Ajánlott egy olyan kategóriát használni, amelynek a típusa Bejelentések (Announcement), így új beszélgetéseket csak az adminisztrátorok, karbantartók és a giscus hozhatnak létre.
Illeszkedő beszélgetésre való kereséskor a giscus csak ebben a kategóriában keressen.
Funkciók
Válaszd ki, hogy melyik funkciók legyenek engedélyezve.
A bejegyzéshez tartozó reakciók a hozzászólások előtt jelenjenek meg.
A hozzászólások metaadatai rendszeresen kerüljenek elküldésre a szülő ablaknak (a beágyazó oldalnak). Bemutatásként engedélyezés után nyisd meg a böngésző konzolját ezen az oldalon. További részletekért lásd a dokumentációt.
A hozzászólás mező a hozzászólások fölé kerül, így a felhasználók hozzászólhatnak anélkül, hogy a vitafórum aljára kellene görgetniük.
A hozzászólások betöltése elhalasztódik, amíg a felhasználó a hozzászólások konténer eleméhez közel nem görget. Ezt úgy érjük el, hogy az <iframe> elemhez hozzáadjuk a loading="lazy" attribútumot.
Téma
Válasz egy témát, amely illeszkedik a weboldalához. Nem talál megfelelőt? Járulj hozzá egy új téma elkészítéséhez.
Giscus engedélyezése
Add hozzá a következő <script> elemet a weboldalhoz, oda, ahol a hozzászólásokat meg szeretnéd jeleníteni. Ha létezik egy giscus osztállyal rendelkező elem, a hozzászólások oda kerülnek.
Nem állítottad be a repo és/vagy a kategória értékét. Ezek a mezők nem fognak megjelenni, amíg ki nem töltöd őket.
<scriptsrc="https://giscus.app/client.js"
data-repo="[ADD MEG A REPÓT]"
data-repo-id="[ADD MEG A REPO ID-T]"
data-category="[ADD MEG A KATEGÓRIA NEVÉT]"
data-category-id="[ADD MEG A KATEGÓRIA ID-T]"
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="hu"
crossorigin="anonymous"
async></script>
A hozzászólásokat befoglaló konténer elrendezését a .giscus és a .giscus-frame CSS kiválasztók segítségével szabhatod testre a beágyazó oldalról.
Ha korábban olyan rendszereket használtál, amelyek a GitHub Issues-t használják (pl. utterances, gitalk), átalakíthatod a meglévő issue-kat beszélgetésekké. Az átalakítás után csak győződj meg róla, hogy a beszélgetések címei és az oldalak közötti leképezés helyes, és a giscus automatikusan használni fogja a beszélgetéseket.
giscus
Egy hozzászólási rendszer, ami a GitHub Discussions adta lehetőségeket használja. Segítségével látogatóid hozzászólásokat és reakciókat hagyhatnak weboldaladon a GitHub által! Erősen inspirálta az utterances.
Hogyan működik
Amikor a giscus betöltődik, a GitHub Discussions keresési API használatával megkeresi az oldalhoz tartozó beszélgetést egy választott leképezés alapján (URL,
pathname,<title>, stb.). Ha nem található egyező beszélgetés, a giscus bot automatikusan létrehoz egyet, amikor valaki először hagy egy hozzászólást vagy reakciót.A hozzászóláshoz a látogatóknak engedélyezniük kell a giscus alkalmazást számára a GitHub OAuth folyamat segítségével, hogy a nevükben hozzászólhassanak. Alternatív megoldásként a látogatók közvetlenül a GitHubon is hozzászólhatnak. A hozzászólásokat a GitHubon moderálhatod.
Beállítások
Nyelv
Válaszd ki giscus megjelenítési nyelvét. Nem találod? Járulj hozzá a lokalizáció elkészítéséhez.
Repository
Válaszd ki, melyik repository-hoz kapcsolódjon a giscus. Győződj meg róla, hogy:
Oldal ↔️ Beszélgetések leképezése
Válaszd ki a beágyazott oldal és a beágyazott beszélgetés közötti leképezést.
A GitHub fuzzy keresési módszeréből adódó helytelen egyezések elkerülhetők szigorú egyezés használatával, ha több hasonló című beszélgetés van. További részletekért lásd a dokumentációt.
Beszélgetés kategóriája
Válaszd ki, milyen kategóriában jöjjenek létre az új beszélgetések. Ajánlott egy olyan kategóriát használni, amelynek a típusa Bejelentések (Announcement), így új beszélgetéseket csak az adminisztrátorok, karbantartók és a giscus hozhatnak létre.
Illeszkedő beszélgetésre való kereséskor a giscus csak ebben a kategóriában keressen.
Funkciók
Válaszd ki, hogy melyik funkciók legyenek engedélyezve.
A bejegyzéshez tartozó reakciók a hozzászólások előtt jelenjenek meg.
A hozzászólások metaadatai rendszeresen kerüljenek elküldésre a szülő ablaknak (a beágyazó oldalnak). Bemutatásként engedélyezés után nyisd meg a böngésző konzolját ezen az oldalon. További részletekért lásd a dokumentációt.
A hozzászólás mező a hozzászólások fölé kerül, így a felhasználók hozzászólhatnak anélkül, hogy a vitafórum aljára kellene görgetniük.
A hozzászólások betöltése elhalasztódik, amíg a felhasználó a hozzászólások konténer eleméhez közel nem görget. Ezt úgy érjük el, hogy az
<iframe>elemhez hozzáadjuk aloading="lazy"attribútumot.Téma
Válasz egy témát, amely illeszkedik a weboldalához. Nem talál megfelelőt? Járulj hozzá egy új téma elkészítéséhez.
Giscus engedélyezése
Add hozzá a következő
<script>elemet a weboldalhoz, oda, ahol a hozzászólásokat meg szeretnéd jeleníteni. Ha létezik egygiscusosztállyal rendelkező elem, a hozzászólások oda kerülnek.A hozzászólásokat befoglaló konténer elrendezését a
.giscusés a.giscus-frameCSS kiválasztók segítségével szabhatod testre a beágyazó oldalról.Ha giscust használsz, fontold meg a giscus megcsillagozását 🌟 a GitHubon és a
giscustéma hozzáadását a repódhoz! 🎉Haladó beállítások
További konfigurációt (pl. engedélyezett originek) adhatsz hozzá a haladó használati útmutató követésével.
Ha giscust React, Vue vagy Svelte segítségével szeretnéd használni, nézd meg a giscus komponens könyvtárat.
Áttérés giscusra
Ha korábban olyan rendszereket használtál, amelyek a GitHub Issues-t használják (pl. utterances, gitalk), átalakíthatod a meglévő issue-kat beszélgetésekké. Az átalakítás után csak győződj meg róla, hogy a beszélgetések címei és az oldalak közötti leképezés helyes, és a giscus automatikusan használni fogja a beszélgetéseket.
Weboldalak, amelyek giscust használnak
Hozzájárulás
Lásd a CONTRIBUTING.md fájlt
Próbáld ki 👇👇👇