什么是 hpc-gitment?
hpc-gitment 是一款基于 GitHub Issues 的评论系统。它不依赖任何第三方评论系统,也不需要后端支持,只需要一个 GitHub 账号即可使用。
hpc-gitment 的特点
- 基于 GitHub Issues 的评论系统,不需要第三方评论系统,也不需要后端。
- 支持 Markdown 格式的评论。
- 自适应移动设备。
- 支持多语言。
- 安全,管理方便。
如何使用 hpc-gitment?
1. 安装 hpc-gitment
npm install hpc-gitment
2. 在项目中引入 hpc-gitment
-- -------------------- ---- ------- ------ ------- ---- ------------- ----- ------- - --- --------- --- --- ---- -- --------- ------ ------- ----- ---- ------ --- ----- ----------- -- -------- ------ - ---------- ------- -- ---- ----- --- - ------ -- -------------- ------- -- ---- ----- --- - ------ ------ -- ------ ------- -- ----------- --- -- --------------------------
3. 在 Gitment 的仓库中创建 Issues
hpc-gitment 的评论数据将存储在你的 GitHub 仓库的 Issues 中。在你的 Gitment 的仓库中创建一个 Issues,用于存储该页面的评论。
4. 在页面中集成 hpc-gitment
在你想添加评论功能的页面中,新建一个容器用于渲染评论区,并初始化 hpc-gitment。
<div id="gitment-container"></div>
-- -------------------- ---- ------- ------ ------- ---- ------------- ----- ------- - --- --------- --- --- ---- ------ ------- ----- ----- ----------- ------ - ---------- ------- -------------- ------- -- ------ ------- -- ------------------------------------ -- -------
注意,需要将页面 ID、GitHub 用户名、存储评论的仓库名、OAuth App 的 Client ID 和 Client Secret 替换成你自己的。
hpc-gitment 参数说明
1. id
- 必填:是
- 类型:String
- 说明:该页面的唯一标识符,可以是页面的 URL。
2. owner
- 必填:是
- 类型:String
- 说明:你的 GitHub 用户名。
3. repo
- 必填:是
- 类型:String
- 说明:存储评论的仓库名。
4. oauth
- 必填:是
- 类型:Object
- 说明:OAuth App 的配置信息,需要先创建一个 OAuth App,并设置正确的 Redirect URL。
5. theme
- 必填:否
- 类型:String
- 可选值:light(默认)、dark
- 说明:hpc-gitment 的主题。
总结
hpc-gitment 是一款非常实用的评论系统,其使用简单,无需后端托管,能够快速为网站添加评论功能。希望本教程能够对大家有所帮助。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60056e4481e8991b448e73bc