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を作成します。

サイト訪問者のコメントはgiscus appによって訪問者に代わって投稿されるために、GitHub OAuth flowを利用した連携設定が行われる必要があります。あるいは、サイト訪問者はGitHub Discussionに直接コメントすることも可能です。コメントはGitHub上で管理することができます。

giscusを利用する場合は、giscusにGitHubスター🌟を付けたり、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 (العربية)
• Català
• Dansk
• Deutsch
• English
• Esperanto
• Español
• Persian (فارسی)
• Français
• Ελληνικά
• Srpsko-Hrvatski (BCMS)
• עברית
• Magyar
• Indonesia
• Italiano
• 日本語
• ភាសាខ្មែរ
• 한국어
• Nederlands
• Polski
• Português
• Română
• Русский
• ภาษาไทย
• Türkçe
• Tiếng Việt
• Українська
• O'zbek
• 简体中文
• 繁體中文