@giscusgiscus

giscus

Un sistema de comentaris desenvolupat amb Discussions de GitHub. Permet als visitants deixar comentaris i reaccions al teu lloc web mitjançant GitHub! Inspirat en utterances.

Nota:
giscus segueix sent un projecte en desenvolupament. GitHub també continua desenvolupant activament les Discussions i la seva API. Per tant, és possible que algunes característiques de giscus puguin trencar-se o canviar amb el temps. És recomanable mantenir-se actualitzat amb les últimes versions i actualitzacions de giscus i seguir les actualitzacions relacionades amb les Discussions i la seva API a GitHub. Això assegurarà que giscus segueixi funcionant de manera òptima i s'aprofiti de les últimes funcionalitats i millores.

Com funciona

Quan es carrega giscus, s'utilitza l'API de cerca de discussions de GitHub per trobar la discussió associada amb la pàgina en funció de la forma de mapeig triada (URL, pathname, <title>, etc.). Si no es pot trobar cap discussió que coincideixi, el bot giscus crearà automàticament una discussió la primera vegada que algú deixi un comentari o una reacció.

Per deixar un comentari, els visitants han d'autoritzar l'aplicació de giscus per publicar en el seu nom utilitzant el flux de GitHub OAuth. Alternativament, els visitants poden comentar directament a la Discussió de GitHub. Pots moderar els comentaris a GitHub.

Configuració

Idioma

Seleccioneu l'idioma en què es mostrarà giscus. No trobes el teu idioma? Pots Contribuir amb la traducció.

Repositori

Selecciona el repositori al que es connectarà giscus. Assegura't del següent:

  1. El repositori es públic. De no ser així els visitants no podran veure els comentaris.
  2. L'aplicació de giscus està instal·lada. De no ser així els visitants no podran comentar ni reaccionar.
  3. La funció de Discussió està activa al teu repositori.

Un repositori públic de GitHub. És el repositori on s'enllaçaran les discussions.

Pàgina ↔️ Mapeig de discussions

Selecciona la forma de mapeig, entre la pàgina i les discussions

giscus buscarà una discussió amb un títol que contingui el pathname de la pàgina.

giscus buscarà una discussió amb un títol que contingui la URL de la pàgina.

giscus buscarà una discussió amb un títol que contingui l'etiqueta HTML <title> de la pàgina.

giscus buscarà una discussió amb un títol que contingui el valor de l'etiqueta HTML <meta property="og:title">.

giscus buscarà una discussió amb un títol que contingui el terme especificat.

giscus carregarà una discussió específica per número. Aquesta opció no admet la creació automàtica de discussions.

Evita discrepàncies a causa del mètode de cerca difusa de GitHub quan hi ha diverses discussions amb títols similars. Consulta la documentació per obtenir més detalls.

Categoria de discussió

Selecciona la categoria on es crearan noves discussions. Es recomana utilitzar una categoria amb el tipus Announcement perquè només els mantenedors i giscus puguin crear noves discussions.

En cercar una discussió, giscus buscarà exclusivament en aquesta categoria.

Característiques

Selecciona les funcionalitats específiques que vols habilitar.

Les reaccions de la publicació principal es mostraran abans dels comentaris.

Les metadades de discussió s'enviaran periòdicament a la finestra principal (la pàgina d'incrustació). Per a una demostració, habilita aquesta opció i obre la consola del teu navegador en aquesta pàgina. Consulta la documentació per obtenir més detalls.

El quadre d'entrada de comentaris es col·locarà sobre els comentaris perquè els usuaris puguin deixar un comentari sense haver de desplaçar-se fins al final de la discussió.

La càrrega dels comentaris s'ajornarà fins que l'usuari es desplaci prop del contenidor de comentaris. Això es fa afegint loading="lazy" a l'element <iframe>.

Tema

Selecciona un tema que coincideixi amb el teu lloc web. No pots trobar-ne cap que ho faci? Contribueix amb un nou tema.

Habilitar giscus

Afegeix l'etiqueta següent <script> a la plantilla del teu lloc web on desitgis que apareguin els comentaris. Si hi ha un element amb la classe giscus, els comentaris es mostraran allà.

No has configurat el teu repositori i/o categoria. Els valors d'aquests camps no es mostraran fins que els complets.
<script src="https://giscus.app/client.js"
        data-repo="[URL REPOSITORI]"
        data-repo-id="[REPOSITORI ID]"
        data-category="[NOM CATEGORIA]"
        data-category-id="[ID CATEGORIA]"
        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="ca"
        crossorigin="anonymous"
        async>
</script>

Pots personalitzar el disseny del contenidor utilitzant els selectors .giscus i .giscus-frame de la pàgina d'incrustració.

Si estàs utilitzant giscus, considera recomanar 🌟 giscus a GitHub i afegir el tema giscus al teu repositori! 🎉

Ús avançat

Pots afegir configuracions addicionals (com permetre orígens específics) seguint la guia d'ús avançat.

Per utilitzar giscus amb React, Vue o Svelte, consulta la biblioteca de components de giscus.

Migrant

Si has utilitzat anteriorment altres sistemes que fan servir GitHub Issues (com ara utterances o gitalk), pots convertir les issues existents en discussions. Després de la conversió, assegura't que el mapeig entre els títols de la discussió i les pàgines sigui correcte, i giscus utilitzarà automàticament les discussions.

Webs que utilitzen giscus

Contribució

Veure CONTRIBUTING.md

Prova'l 👇👇👇

Powered by Vercel