Un sistema di commenti basato su GitHub Discussions. Consente ai visitatori di lasciare commenti e reazioni sul tuo sito Web tramite GitHub! Fortemente ispirato a utterances.
Nota:
giscus è ancora in fase di sviluppo attivo. GitHub sta ancora sviluppando attivamente Discussions e le sue API. Pertanto, alcune caratteristiche di giscus possono smettere di funzionare o cambiare nel tempo.
Come funziona
Quando giscus viene caricato, l'API di ricerca di discussioni di GitHub viene utilizzata per trovare la discussione associata alla pagina in base a una mappatura scelta (URL, pathname, <title>, ecc.). Se non è possibile trovare una discussione corrispondente, il bot di giscus creerà automaticamente una discussione la prima volta che qualcuno lascia un commento o una reazione.
Per commentare, i visitatori devono autorizzare l'app giscus a pubblicare per loro conto utilizzando l'autorizzazione OAuth di GitHub. In alternativa, i visitatori possono commentare direttamente la discussione su GitHub. Puoi moderare i commenti su GitHub.
Configurazione
Lingua
Scegli la lingua in cui verrà mostrato giscus. Non trovi la tua lingua? Contribuisci con una traduzione
Repository
Scegli la repository a cui si connetterà giscus. Assicurati che:
La repository sia pubblica, altrimenti i visitatori non potranno vedere la discussione.
L'app giscus sia installata, altrimenti i visitatori non potranno commentare o aggiungere reazioni.
Scegli la mappatura tra la pagina e la discussione.
Evita le discrepanze dovute al metodo di ricerca fuzzy di GitHub quando ci sono più discussioni con titoli simili. Vedi la documentazione per maggiori dettagli.
Categoria della discussione
Scegli la categoria in cui le nuove discussioni verranno create. È consigliato utilizzare una categoria con il tipo Announcements così che le nuove discussioni possono essere create solo dai maintainers e da giscus.
Quando si cerca una discussione corrispondente, giscus cercherà solo in questa categoria.
Caratteristiche
Scegli se abilitare funzionalità specifiche.
Le reazioni al post principale della discussione verranno mostrate prima dei commenti.
I metadati della discussione verranno inviati periodicamente alla window principale (la pagina). A scopo dimostrativo, abilita questa opzione e apri la console del tuo browser in questa pagina. Vedi la documentazione per maggiori dettagli.
La casella di immissione dei commenti verrà posizionata sopra i commenti, in modo che gli utenti possano lasciare un commento senza scorrere fino in fondo alla discussione.
Il caricamento dei commenti sarà posticipato fino a quando l'utente non scorrerà vicino al contenitore dei commenti. Questo viene fatto aggiungendo loading="lazy" all'elemento <iframe>.
Tema
Scegli un tema che corrisponda al tuo sito web. Non riesci a trovarne uno adatto? Contribuisci a un nuovo tema.
Abilita giscus
Aggiungi il seguente tag <script> al template del tuo sito web in cui desideri che vengano visualizzati i commenti. Se esiste un elemento con la classe giscus, i commenti verranno invece inseriti lì.
Non hai configurato il tuo repository e/o la tua categoria. I valori per quei campi non verranno mostrati finché non li compili.
<scriptsrc="https://giscus.app/client.js"
data-repo="[INSERISCI REPO]"
data-repo-id="[INSERISCI ID REPO]"
data-category="[INSERISCI NOME CATEGORIA]"
data-category-id="[INSERISCI 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="it"
crossorigin="anonymous"
async></script>
Puoi personalizzare il layout del container utilizzando i selettori .giscus e .giscus-frame dalla pagina.
È possibile aggiungere ulteriori configurazioni (ad es. consentire origins specifiche) seguendo la guida di utilizzo avanzato.
Per utilizzare giscus con React, Vue o Svelte, dai un'occhiata alla libreria giscus component.
Migrazione
Se in precedenza hai utilizzato altri sistemi che utilizzano gli Issues di GitHub (es. utterances o gitalk), puoi convertire gli issues esistenti in discussioni. Dopo la conversione, assicurati solo che la mappatura tra i titoli delle discussioni e le pagine sia corretta, quindi giscus utilizzerà automaticamente le discussioni.
giscus
Un sistema di commenti basato su GitHub Discussions. Consente ai visitatori di lasciare commenti e reazioni sul tuo sito Web tramite GitHub! Fortemente ispirato a utterances.
Come funziona
Quando giscus viene caricato, l'API di ricerca di discussioni di GitHub viene utilizzata per trovare la discussione associata alla pagina in base a una mappatura scelta (URL,
pathname,<title>, ecc.). Se non è possibile trovare una discussione corrispondente, il bot di giscus creerà automaticamente una discussione la prima volta che qualcuno lascia un commento o una reazione.Per commentare, i visitatori devono autorizzare l'app giscus a pubblicare per loro conto utilizzando l'autorizzazione OAuth di GitHub. In alternativa, i visitatori possono commentare direttamente la discussione su GitHub. Puoi moderare i commenti su GitHub.
Configurazione
Lingua
Scegli la lingua in cui verrà mostrato giscus. Non trovi la tua lingua? Contribuisci con una traduzione
Repository
Scegli la repository a cui si connetterà giscus. Assicurati che:
Mappatura Pagina ↔️ Discussions
Scegli la mappatura tra la pagina e la discussione.
Evita le discrepanze dovute al metodo di ricerca fuzzy di GitHub quando ci sono più discussioni con titoli simili. Vedi la documentazione per maggiori dettagli.
Categoria della discussione
Scegli la categoria in cui le nuove discussioni verranno create. È consigliato utilizzare una categoria con il tipo Announcements così che le nuove discussioni possono essere create solo dai maintainers e da giscus.
Quando si cerca una discussione corrispondente, giscus cercherà solo in questa categoria.
Caratteristiche
Scegli se abilitare funzionalità specifiche.
Le reazioni al post principale della discussione verranno mostrate prima dei commenti.
I metadati della discussione verranno inviati periodicamente alla window principale (la pagina). A scopo dimostrativo, abilita questa opzione e apri la console del tuo browser in questa pagina. Vedi la documentazione per maggiori dettagli.
La casella di immissione dei commenti verrà posizionata sopra i commenti, in modo che gli utenti possano lasciare un commento senza scorrere fino in fondo alla discussione.
Il caricamento dei commenti sarà posticipato fino a quando l'utente non scorrerà vicino al contenitore dei commenti. Questo viene fatto aggiungendo
loading="lazy"all'elemento<iframe>.Tema
Scegli un tema che corrisponda al tuo sito web. Non riesci a trovarne uno adatto? Contribuisci a un nuovo tema.
Abilita giscus
Aggiungi il seguente tag
<script>al template del tuo sito web in cui desideri che vengano visualizzati i commenti. Se esiste un elemento con la classegiscus, i commenti verranno invece inseriti lì.Puoi personalizzare il layout del container utilizzando i selettori
.giscuse.giscus-framedalla pagina.Se usi giscus, metti una stella 🌟 su GitHub e aggiungi il topic
giscusalla tua repository! 🎉Utilizzo avanzato
È possibile aggiungere ulteriori configurazioni (ad es. consentire origins specifiche) seguendo la guida di utilizzo avanzato.
Per utilizzare giscus con React, Vue o Svelte, dai un'occhiata alla libreria giscus component.
Migrazione
Se in precedenza hai utilizzato altri sistemi che utilizzano gli Issues di GitHub (es. utterances o gitalk), puoi convertire gli issues esistenti in discussioni. Dopo la conversione, assicurati solo che la mappatura tra i titoli delle discussioni e le pagine sia corretta, quindi giscus utilizzerà automaticamente le discussioni.
Siti che usano giscus
Contribuzioni
Vedi CONTRIBUTING.md
Prova 👇👇👇