关于Giscus需要了解的事情

2023/09/08 GitHub 共 869 字,约 3 分钟
AI智谷X

关于Giscus需要了解的事情

  利用 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 并[为你的仓库][topic-howto]添加 [giscus][giscus-topic] 话题!🎉

高级用法

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

  如果想要在 React、Vue 和 Svelte 中使用 giscus,请查看 [giscus 组件库][giscus-component]。

迁移

  如果你使用过利用 GitHub Issue 实现的评论系统(如 utterances、[gitalk][gitalk]),你可[将已有的 issue 转换成 discussion][convert]。转换后,只要确保 discussion 标题与页面的映射关系正确,giscus 就会自动使用这些 discussion。


文档信息

Search

    Table of Contents