Gitment 使用教程

项目介绍

Gitment 是一个基于 GitHub Issues 的评论系统，允许用户在静态网页上添加评论功能。它利用 GitHub 的 OAuth 和 Issues API 来实现评论的存储和展示。Gitment 特别适合那些希望在不依赖外部服务的情况下为静态网站添加评论功能的开发者。

项目快速启动

安装

首先，你需要在你的项目中引入 Gitment。可以通过以下方式在你的 HTML 文件中添加 Gitment 的脚本和样式：

<link rel="stylesheet" href="https://imsun.github.io/gitment/style/default.css">
<script src="https://imsun.github.io/gitment/dist/gitment.browser.js"></script>

初始化 Gitment

在你的页面中添加以下代码来初始化 Gitment：

<div id="container"></div>
<script>
  var gitment = new Gitment({
    id: '页面 ID', // 可选。默认为 location.href
    owner: '你的 GitHub ID',
    repo: '你的仓库名',
    oauth: {
      client_id: '你的 client ID',
      client_secret: '你的 client secret',
    },
  });
  gitment.render('container');
</script>

获取 OAuth 密钥

为了使用 Gitment，你需要在 GitHub 上创建一个新的 OAuth 应用，并获取 client_id 和 client_secret。具体步骤如下：

1. 访问 GitHub 的 开发者设置 页面。
2. 点击 "New OAuth App"。
3. 填写应用信息，其中 "Authorization callback URL" 可以填写你的网站地址。
4. 创建应用后，你将获得 client_id 和 client_secret。

应用案例和最佳实践

案例一：个人博客

许多开发者使用 Gitment 为自己的个人博客添加评论功能。通过将 Gitment 集成到博客的每篇文章页面，读者可以在 GitHub 上登录并发表评论，评论会存储在开发者的 GitHub 仓库中。

案例二：开源项目文档

开源项目文档页面也经常使用 Gitment 来收集用户反馈和讨论。这种方式不仅方便用户参与，还能将讨论内容与项目代码存储在同一平台上，便于管理和回顾。

典型生态项目

Gitment 作为一个评论系统，其生态主要围绕 GitHub 展开。以下是一些与 Gitment 相关的典型生态项目：

• GitHub Pages: 用于托管静态网站，是 Gitment 的主要应用场景之一。
• Jekyll/Hexo: 静态网站生成器，常与 Gitment 结合使用，为生成的静态页面添加评论功能。
• GitHub API: Gitment 的核心依赖，用于实现评论的存储和读取。

通过这些生态项目的支持，Gitment 能够为静态网站提供一个简单而强大的评论解决方案。