Skip to content

Latest commit

 

History

History
100 lines (75 loc) · 4.5 KB

README.zh-CN.md

File metadata and controls

100 lines (75 loc) · 4.5 KB

GitHub Discussions 驱动的评论系统。让访客借助 GitHub 在你的网站上留下评论和反应吧!本项目受 utterances 强烈启发。

注意:
giscus 仍处于活跃开发中。GitHub 也还在活跃地开发 Discussions 及其 API。因此,一些 giscus 的特性可能随时间损坏或改变。

它如何运作

giscus 加载时,会使用 GitHub Discussions 搜索 API 根据选定的映射方式(如 URL、pathname<title> 等)来查找与当前页面关联的 discussion。如果找不到匹配的 discussion,giscus bot 就会在第一次有人留下评论或回应时自动创建一个 discussion。

要评论,访客必须按 GitHub OAuth 流程授权 giscus app 代表他发帖。或者访客也可以直接在 GitHub Discussion 里评论。你可以在 GitHub 上管理评论。

如果你使用 giscus,请考虑在 GitHub 上 star 🌟 giscus为你的仓库添加 giscus 话题!🎉

高级用法

你可以依照高级用法指南添加额外配置(例如允许特定来源)。

要在 React、Vue 和 Svelte 中使用 giscus,请查看 giscus 组件库

迁移

如果你曾经使用过其它利用 GitHub Issue 的评论系统(如 utterancesgitalk),你可把已有的 issue 转换成 discussion。转换后,只要确保 discussion 标题与页面的映射关系正确,giscus 就会自动使用这些 discussion。

正使用 giscus 的网站

贡献

请查看 CONTRIBUTING.md


本 README 有以下语言版本:

由 Vercel 驱动