Comments
评论服务
把 CNB Issue 变成任意网页的评论区。粘贴一行 script,访客登录后即可评论,评论实时同步到你的仓库。
生成嵌入代码
paste into your page
<script src="https://commit.cool/client.js" repo="org/project" issue-term="pathname" theme="light" layout="classic" crossorigin="anonymous" async ></script>
配置项
- repo必填
- 评论存放的 CNB 仓库,格式 org/project(支持多级组织)。评论会以 Issue 的形式创建在该仓库。
- issue-term
- 决定页面与 Issue 的对应关系,默认 pathname。
- issue-id
- 仅 issue-term=custom 时使用,作为 Issue 标题。
- theme
- light 或 dark,默认 dark,需与你的页面底色匹配。
- layout
- classic:所有评论靠左;chat:对话式,自己的评论在右侧。
issue-term 取值
- pathname
- 以页面路径(如 /posts/hello)作为 Issue 标题,最常用,域名变化不影响评论。
- url
- 以完整 URL 作为标题,不同域名 / 参数视为不同页面。
- title
- 以 document.title 作为标题,改标题会丢失原有评论,慎用。
- custom
- 自行指定 issue-id,适合需要稳定标识的场景。
评论按 Issue 标题匹配;找不到对应 Issue 时,已登录用户首次评论会自动创建。
特性
- 以 CNB Issue 作为存储,数据完全在你自己的仓库里
- CNB OAuth 登录,无需额外账号体系
- Markdown 渲染,Issue 链接与 @ 用户提及自动识别,输出经过 XSS 清洗
- @ 提及候选、表情包、草稿自动保存
- 新评论实时刷新,无需手动刷新页面
- iframe 隔离,样式互不干扰,高度自适应
效果预览
下面是真实运行的评论区(来自 CommitCool 仓库Issue #1),会随上方的 theme / layout 切换。