Gitalk 是一个基于 GitHub Issues 的评论插件。使用 Gitalk 可以轻松地将一个 GitHub 仓库的 Issues 作为评论系统添加到你的博客或静态网站上。
在这篇文章中,我们将介绍如何使用 npm 包 Gitalk,并提供详细、有深度的指导和示例代码。
安装 Gitalk
首先,让我们安装 Gitalk。
使用 npm:
npm install gitalk --save
或者使用 yarn:
yarn add gitalk
配置 Gitalk
要配置 Gitalk,你需要创建一个 GitHub 应用,获取一个 client ID 和 client secret。
- 登录 GitHub,然后转到 Settings > Developer settings > OAuth Apps。
- 点击 "New OAuth App"。
- 填写表单,其中 "Homepage URL" 和 "Authorization callback URL" 分别为您部署 Gitalk 的 URL 地址。
- 创建成功后,您可以在应用程序的页面中找到 client ID 和 client secret。
有了这些准备工作,我们就可以开始配置 Gitalk 了:
-- -------------------- ---- ------- ------ ------ ---- --------- ----- ------ - --- -------- --------- ----------------- ------------- --------------------- ----- ------------ ------ ---------------- ------ ------------------ --- ------------------ --- ----------------------------------
在上面的示例中,clientID
和 clientSecret
分别是你的 GitHub 应用程序的 client ID 和 client secret。owner
是你的 GitHub 用户名,repo
是你的存储库名称,admin
是存储库的管理者用户名(可以有多个),id
是当前页面的 ID(通常为路径名)。
使用 Gitalk
一旦你完成了配置,Gitalk 就会自动拉取 GitHub 存储库中与当前页面相同的 Issues,并显示在您的网站上。
你也可以使用 gitalkInstance.render('gitalk-container')
方法手动渲染评论框。
以下是一个完整的示例:
-- -------------------- ---- ------- --------- ----- ------ ------ ----- ---------------- --------- ------------ ------- ------ ----------- -- -- ---------- ---- ---------------------------- ------- ---------------------------------------------------------------------- -------- ----- ------ - --- -------- --------- ----------------- ------------- --------------------- ----- ------------ ------ ---------------- ------ ------------------ --- ------------------ --- ---------------------------------- --------- ------- -------
以上就是使用 npm 包 Gitalk 的教程和示例代码。希望这篇文章对你有所帮助!
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/35451