README.ja.md

giscus

GitHub Discussionsを利用したコメントシステム。サイト訪問者GitHubを利用したコメントとリアクションを提供しましょう！このプロジェクトはutterancesを強くインスパイヤしています。

• オープンソース。 🌏
• 追跡や広告は無く、無料です。 📡 🚫
• データベースは不要です。全データはGitHub Discussionsに保管されます。
• カスタムテーマに対応! 🌗
• 複数の言語に対応。 🌐
• 詳細な設定項目。 🔧
• 自動的に新しいコメントと編集をGitHubから取得します。 🔃
• 自己ホスティングが可能! 🤳

情報:
giscusは現在も活発に開発されています。GitHubも同様にDiscussionsとそのAPIを活発に開発しています。そのため、giscusの機能の一部が正常に動作しなくなったり、機能の変更がされる場合があります。

仕組み

giscus読み込み時にGitHub Discussions search APIを利用してページ連携設定(URL、パス、<title>など)に基づき紐づけられたDiscussionを読み込みます。もし紐づけられたDiscussionがない場合、giscusは最初にコメントやリアクションが為された際に自動的にDiscussionを作成します。

コメントするには、サイト訪問者はGitHub OAuth flowを利用してgiscus appを自分の代わりに投稿させるために連携させる必要があります。もしくは、サイト訪問者はGitHub Discussionに直接コメントを記述することもできます。あなたは、GitHub上でコメントを削除することができます。

giscusを利用する場合は、GitHub上のgiscusにスター🌟を付けたり、giscusトピックをリポジトリに設定していただけますと幸いです! 🎉

上級者向け機能

追加の設定(特定オリジンのみの許可など)。上級者向け機能ガイドをご参照ください。

giscusをReactやVue、Svelteで利用する場合はgiscusコンポーネントライブラリをご参照ください。

移行

もし以前GitHub Issuesを利用したツール(utterancesやgitalkなど)を利用していたばあい、既存のIssueをDiscussionに変換する事が出来ます。返還後はdiscussionタイトルが連携設定に基づき正しく設定されていることを確認してください。その後は、giscusが自動的にdiscussionを利用します。

giscusを利用しているサイト

• laymonage.com
• os.phil-opp.com
• Stats and R
• Tech Debt Burndown Podcast
• 上記以外にも！

コントリビュート

CONTRIBUTING.mdをご参照ください。

---

このREADMEは下記の言語も存在します:

• Arabic (العربية)
• Deutsch
• Deutsch (Schweiz)
• English
• Español
• Français
• Indonesia
• Italiano
• 日本語
• 한국어
• Nederlands
• Polski
• Português
• Română
• Русский
• Türkçe
• Tiếng Việt
• 简体中文
• 繁體中文