npm 包 utterance 使用教程

AI 编程助手,豆包旗下的编程助手,提供智能补全、智能预测、智能问答等能力,节省开发时间,释放脑海中的创造力,支持 VSCode,点击体验 AI

什么是 npm 包 utterance

npm 包 utterance 是一个能够将 GitHub Issue 转化为评论区的工具。利用 utterance,你不再需要手动维护你的博客、网站的评论功能,能够大幅减少你的维护工作量。

如何使用 npm 包 utterance

1. 添加 utterances 的代码

首先,你需要在你的网站页面上添加如下代码片段:

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

接下来,我们来一一解释这段代码的含义:

  • owner: 你的 GitHub 用户名或组织名称
  • repo:你的 GitHub 项目名称
  • issue-term:该参数是你当前页面对应的 Unique Path,可以自动匹配到 GitHub Issues 里具体讨论的 Issue 页面。注意,issue-term 参数不可与 repo 参数一起使用。
  • theme:utterances 的主题,默认是 Github-light,也可以自定义。

2. 创建 Github APP

由于 utterances 对于 GitHub Issues 的读取和写入有权限问题,因此需要创建一个 Github APP,并向你的 repository 授权。

具体操作步骤:

  • 打开 https://github.com/settings/apps/new 网址
  • 填写 App 名称和 GitHub 仓库地址
  • 在下方勾选需要授权的项,包括 Issues,Pull Requests 即可
  • 完成后在生成的 APP 详细信息页面获取 APP ID 和 APP Secret

3. 配置 ACCESS_TOKEN

存储 ACCESS_TOKEN 有多种方式,这里我们介绍使用 LocalStorage 存储。

首先,需要向用户请求 GitHub 官方授权,通过生成的 Github APP 进行授权操作,获取到 ACCESS_TOKEN。

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

上述代码中的 CLIENT_ID 需要替换成你自己的。

授权后,接下来需要将 ACCESS_TOKEN 以及刚才配置的 Github 相关信息进行存储。以 LocalStorage 为例,示例代码如下:

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

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

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

4. 使用 utterances

最后,就可以在你的网页或博客中直接使用 utterances 了。当用户评论时,可以在 GitHub Issues 中进行相应的回复和交互操作。

总结

通过以上步骤的操作,我们可以将 utterances 工具应用到自己的网站或博客中,为用户打造更加方便快捷的评论体验。

值得注意的是,如果遇到使用上的困难或问题,可以及时参考官方文档或查找相关社区资源。通过不断的学习和实践,我们可以更好的掌握这样一种强大的工具,带来更好的用户体验和博客管理效率。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/600562d781e8991b448e031a


猜你喜欢

  • npm 包 @rocketpants/model 使用教程

    在前端开发中,我们经常使用一些工具和库来帮助我们更高效地完成任务。其中,npm 包是一种非常常见的工具,它可以让我们方便地管理依赖、安装和升级各种前端工具、库和框架。

    3 年前
  • npm 包 @akiellorest/redux-form 的使用教程

    随着前端技术的不断发展,React 成为越来越多开发者的首选框架。而 Redux 则是 React 中状态管理的常用方式。@akiellorest/redux-form 是一个 npm 包,用于方便地...

    3 年前
  • npm 包 fabulous-fork 的使用教程

    一、背景介绍 npm 是一个包管理工具,用于安装、发布、升级和卸载 JavaScript 包,同时也是 Node.js 的包管理工具。在当前的前端领域中,npm 扮演着重要的角色。

    3 年前
  • 使用 npm 包 react-redux-internet-connection 的教程

    对于前端开发者来说,实现网络连接状态的检测是一项必须掌握的技术,无论是开发 web 应用,还是移动应用,都需要对网络状态进行相应的处理和提示。而此时,npm 包 react-redux-interne...

    3 年前
  • npm 包 spostcss-brunch 使用教程

    如果你是前端开发人员,那么你肯定知道 npm 是什么。npm 是一个 Node.js 包管理器,它允许开发人员在自己的项目中使用可重用的代码。在这篇文章中,我们将讨论一个 npm 包,它叫做 spos...

    3 年前
  • npm 包 eslint-config-stripes 使用教程

    1. 什么是 eslint-config-stripes eslint-config-stripes 是一个 npm 包,是为了帮助前端开发人员和团队在进行代码质量的控制和维护时更加高效和便捷而设计的...

    3 年前
  • npm 包 rest-script-runner 使用教程

    前言 在前端开发中,经常会遇到需要模拟 API 接口数据进行开发的情况。此时,我们通常使用一些工具来模拟数据,比如 Mock.js、json-server 等。这些工具可以帮助我们快速地搭建一个假数据...

    3 年前
  • npm 包 docsjs 使用教程

    作为前端工程师,经常会遇到需要编写文档的场景。于是,我们需要一款轻量、易用、美观的文档生成工具。而这时,docsjs 就成为了我的首选。 什么是 docsjs? docsjs 是一款基于 Markdo...

    3 年前
  • npm 包 session-email-notifier-bot 使用教程

    简介 session-email-notifier-bot 是一款基于 Node.js 平台开发的 npm 包,其主要功能是监控用户网站 session 状态并发送邮件通知用户。

    3 年前
  • npm 包 kendo-grid-virtual-scrolling 使用教程

    前言 在 React 开发中,我们经常需要使用表格进行数据展示,而随着数据量的增加,传统的分页方式已经无法满足用户的需求,这时候就需要使用虚拟滚动来进行优化,以提高页面性能和用户体验。

    3 年前
  • npm 包 reaction-carousel 使用教程

    随着前端技术的发展和应用的广泛,越来越多的 npm 包被开发出来,为前端开发者提供诸如表单验证、DOM 操作、路由切换等常用功能。其中,reaction-carousel 是一个非常实用的 npm 包...

    3 年前
  • npm 包 react-frame-animator 使用教程

    简介 react-frame-animator 是一个 React 组件库,可以让你通过它来制作帧动画,支持线性和贝塞尔曲线动画,并且可以方便地进行时间和进度的控制。

    3 年前
  • npm 包 cmark 使用教程

    Markdown 已成为写作、博客、GitHub 文档和其他许多用途的流行格式。但是,有时需要在文件中将其转换为 HTML。在 Node.js 中,可以使用 cmark 包来进行转换。

    3 年前
  • npm 包 r-script-with-bug-fixes 使用教程

    前言 r-script-with-bug-fixes 是一款在 R 语言环境下使用的 npm 包,它提供了一些修复了已知 Bug 的 R 脚本,在使用 R 时可以减少一些不必要的错误和麻烦。

    3 年前
  • npm 包 osm-p2p-sync 使用教程

    引言 在前端开发中,难免会涉及到数据同步和处理。osm-p2p-sync 是一款非常好用的 npm 包,能够使我们在前端中快速将 OpenStreetMap 数据同步到一个 P2P 网络中。

    3 年前
  • 使用 Homebridge-mcu-ismartswitch 包控制智能设备

    Homebridge-mcu-ismartswitch 是一个基于 npm 平台的 Homebridge 插件,可以让你通过 Homebridge 控制智能设备。它支持以下类型的设备:智能插座、智能灯...

    3 年前
  • npm 包 sprites.js 使用教程

    在前端开发中,精灵图是一个常见的优化方式,可以减少 HTTP 请求数量,提高页面的性能。而在精灵图制作的过程中,使用 sprites.js 可以极大地简化这个过程。

    3 年前
  • npm 包 @glimpse/glimpse 使用教程

    前言 @glimpse/glimpse 是一个用于调试和性能分析 JavaScript 程序的 npm 包。它提供了一个轻量级的浏览器扩展程序,让开发者能够快速地获得应用程序的运行时详细信息。

    3 年前
  • npm 包 @ttn/tokebot 使用教程

    简介 @ttn/tokebot 是一个基于 TokeBot 的 npm 包,它可以快速地将 TokeBot 集成到您的前端应用程序中,帮助您在应用程序中方便地获取令牌。

    3 年前
  • npm 包 blinkt 使用教程

    1. 简介 blinkt 是一款专门用于树莓派的 LED 条,可以通过它来控制多彩的 LED 灯光,制作出各种酷炫的效果。本文将介绍如何在前端项目中使用 npm 包 blinkt 来控制 LED 灯光...

    3 年前

相关推荐

    暂无文章