NPM 包 Gitalk 使用教程

Gitalk 是一个基于 GitHub Issues 的评论插件。使用 Gitalk 可以轻松地将一个 GitHub 仓库的 Issues 作为评论系统添加到你的博客或静态网站上。

在这篇文章中,我们将介绍如何使用 npm 包 Gitalk,并提供详细、有深度的指导和示例代码。

安装 Gitalk

首先,让我们安装 Gitalk。

使用 npm:

--- ------- ------ ------

或者使用 yarn:

---- --- ------

配置 Gitalk

要配置 Gitalk,你需要创建一个 GitHub 应用,获取一个 client ID 和 client secret。

  1. 登录 GitHub,然后转到 Settings > Developer settings > OAuth Apps
  2. 点击 "New OAuth App"。
  3. 填写表单,其中 "Homepage URL" 和 "Authorization callback URL" 分别为您部署 Gitalk 的 URL 地址。
  4. 创建成功后,您可以在应用程序的页面中找到 client ID 和 client secret。

有了这些准备工作,我们就可以开始配置 Gitalk 了:

------ ------ ---- ---------

----- ------ - --- --------
  --------- -----------------
  ------------- ---------------------
  ----- ------------
  ------ ----------------
  ------ ------------------
  --- ------------------
---
----------------------------------

在上面的示例中,clientIDclientSecret 分别是你的 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


猜你喜欢

  • npm 包 jqBootstrapValidation 使用教程

    jqBootstrapValidation 是一个基于 jQuery 的表单验证插件,可以用于前端开发中。本文将介绍如何使用 npm 安装和配置 jqBootstrapValidation 插件,并提...

    6 年前
  • npm 包 pangu 使用教程

    什么是 pangu? pangu 是一款支持中英文等多种语言的空格自动调整工具,它可以自动在中英文之间添加或删除空格,以达到更好的阅读体验。 安装 --- ------- -----使用方法 在浏览器...

    6 年前
  • npm包eqcss使用教程

    在前端开发中,CSS是不可或缺的一部分。然而,CSS语言本身存在着一些限制和不足,如选择器的局限性、响应式设计的复杂性等等。为了解决这些问题,出现了一种名为EQCSS的工具,它可以让我们用JavaSc...

    6 年前
  • npm 包 bean 使用教程

    简介 Bean 是一个前端开发中常用的工具库,它封装了很多常见的操作和功能,使得我们可以更快地编写高质量的代码。本文将详细介绍如何使用 Bean 包,并提供示例代码。

    6 年前
  • npm 包 izitoast 使用教程

    简介 izitoast 是一个轻量级的、易于使用且高度可配置的 JavaScript Toast 库,用于在 Web 应用程序中显示通知消息。它支持多种不同的通知类型,包括成功、警告、错误和信息。

    6 年前
  • npm 包 queue-async 使用教程

    在前端开发中,经常需要处理异步任务。但是如果不加以控制和管理,就可能会出现回调地狱和并发量过大等问题。这时可以使用 npm 包 queue-async 来管理异步任务的执行顺序和并发数量。

    6 年前
  • npm 包 blueimp-JavaScript-Templates 使用教程

    简介 blueimp-JavaScript-Templates 是一个 JavaScript 模板引擎,可以通过预设的模板渲染数据,并生成 HTML 内容。它支持单文件模板和批量加载模板文件,同时还提...

    6 年前
  • npm 包 redom 使用教程

    在前端开发中,我们经常需要创建和管理 DOM 元素。RE:DOM 是一个轻量级的 JavaScript 库,它为我们提供了一种简单的、快速的方式来处理 DOM。该库只有 2KB 大小,但是它的功能非常...

    6 年前
  • npm 包 angular-filemanager 使用教程

    Angular-filemanager 是一个使用 AngularJS 实现的文件管理器,可用于在 Web 应用程序中管理文件。本文将介绍如何使用 npm 包 angular-filemanager ...

    6 年前
  • npm包Thorax使用教程

    简介 Thorax 是一个基于 Backbone.js 的前端框架,它提供了更多的组件化和可复用性,使得开发者可以更快速地构建 Web 应用。该框架支持模板预编译、自定义事件、数据绑定等特性,并且拥有...

    6 年前
  • npm包stickyfill使用教程

    简介 在许多前端项目中,我们常常需要使某些元素粘滞在页面上方。然而,在一些浏览器(例如Safari)上,CSS属性position:sticky 的表现并不如人意。

    6 年前
  • npm 包 fukol-grids 使用教程

    fukol-grids 是一个基于 Flexbox 的响应式网格系统,可以帮助前端开发者快速创建灵活的布局。本文将介绍如何使用 fukol-grids,并提供详细的示例代码和指导意义。

    6 年前
  • npm 包 d3-queue 使用教程

    简介 d3-queue 是一个用于管理异步任务队列的npm包,特别适用于前端开发中需要加载和处理大量数据或资源的场景。d3-queue 具有简单易用、高效稳定等特点,是前端开发中不可或缺的工具之一。

    6 年前
  • npm 包 jquery-sortable 使用教程

    简介 jquery-sortable 是一个方便的 jQuery 插件,可以帮助我们实现拖拽排序的功能,不仅可以用在列表中,也可以用于其他元素的排序。该插件使用很广泛,是一个非常实用的前端工具。

    6 年前
  • npm 包 suncalc 使用教程

    简介 suncalc 是一个用于计算日出、日落、黄昏和黎明时间的 JavaScript 库。它可以在前端和后端环境中使用,支持多种操作系统和浏览器。 本文将介绍如何使用 suncalc 库来计算太阳位...

    6 年前
  • NPM包 Backbone.Validation 使用教程

    在现代前端开发中,NPM是一个非常重要的工具,可以通过它来安装和管理很多JavaScript库。Backbone.Validation是一个流行的NPM包,用于验证表单输入。

    6 年前
  • npm 包 joyride 使用教程

    简介 Joyride是一个基于jQuery的引导用户界面的插件,可以帮助开发人员创建漂亮的、交互式的导览。它支持自定义主题和事件,并且非常易于使用。在本文中,我将向您展示如何使用npm包joyride...

    6 年前
  • npm 包 pushy 使用教程

    简介 pushy 是一个专为前端开发人员设计的 npm 包,可以用于实时推送消息到客户端,支持多种通信协议。其主要特点包括: 支持 WebSocket、SSE、Long polling 等多种通信协...

    6 年前
  • npm 包 simple-line-icons 使用教程

    简介 simple-line-icons 是一组包含 189 个矢量图标的开源图标库,可通过 npm 包安装并用于前端开发。这些图标设计简洁且易于使用,可以为你的项目提供优美的视觉效果。

    6 年前
  • npm 包 js-data 使用教程

    什么是 js-data? js-data 是一个用于在客户端和服务器上管理数据的工具库。它提供了一些功能强大且易于使用的 API,帮助开发人员快速地实现数据查询、过滤、排序等操作。

    6 年前

相关推荐

    暂无文章