npm 包 hpc-gitment 使用教程

什么是 hpc-gitment?

hpc-gitment 是一款基于 GitHub Issues 的评论系统。它不依赖任何第三方评论系统,也不需要后端支持,只需要一个 GitHub 账号即可使用。

hpc-gitment 的特点

  1. 基于 GitHub Issues 的评论系统,不需要第三方评论系统,也不需要后端。
  2. 支持 Markdown 格式的评论。
  3. 自适应移动设备。
  4. 支持多语言。
  5. 安全,管理方便。

如何使用 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。

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

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

注意,需要将页面 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


猜你喜欢

  • npm 包 angular-ngrx-crud 使用教程

    介绍 Angular-ngrx-crud 是一个用于 CRUD 操作的 Angular 应用程序的 npm 包,使用了 ngrx 和 Angular Material。

    3 年前
  • npm 包 mztest 使用教程

    介绍 mztest 是一款用于前端单元测试的 npm 包,基于 Mocha 和 Chai 所开发,提供了简洁易用的接口来编写测试用例以及运行测试。 本文将介绍如何使用 mztest 进行前端单元测试,...

    3 年前
  • npm 包 share-aj 使用教程

    在前端开发中,社交分享功能是非常常见的需求。为了让开发者能够更加方便地实现社交分享功能,有一款 npm 包叫做 share-aj ,它提供了丰富的社交分享功能,并且使用简单。

    3 年前
  • npm 包 xstream-crypto 使用教程

    简介 xstream-crypto 是一个基于流加密的 npm 包,主要用于前端网络通信中的数据加密处理。它能够让前端数据传输更加安全可靠,并可以有效的防止数据被篡改、窃取。

    3 年前
  • npm 包 hl-utils 使用教程

    hl-utils 是一个前端开发的工具类库,它包含了常用的工具函数,方便我们在日常开发中快速编写代码。本教程将为大家介绍如何使用 hl-utils,并且以示例代码来讲解其具体用法。

    3 年前
  • npm 包 easy-weather 使用教程

    介绍 easy-weather 是一个 npm 包,可以方便地获取天气预报。它基于 Open Weather Map API,以易用的方式封装了天气 API。 安装 使用 npm 直接安装 easy...

    3 年前
  • npm 包 ppdvux 使用教程

    简介 ppdvux 是一个基于 Vue.js 的 UI 组件库,能够快速搭建页面,并且拥有非常好的可定制性。本文将介绍如何使用 ppdvux。 安装 使用 npm 安装,命令如下: --- -----...

    3 年前
  • npm 包 kit-api 使用教程

    前言 在前端开发中,常常需要使用各种 API,例如网络请求、数据存储等。而使用 npm 包可以方便我们管理和调用这些 API。本文将介绍一个 npm 包 kit-api 的使用方法。

    3 年前
  • 使用 react-native-draftjs-renderer-v16 渲染 Draft.js 编辑器生成的数据

    在 React Native 开发中,使用 Draft.js 编辑器生成数据后,需要将其渲染到前端页面上。此时,可以使用一个开源项目 react-native-draftjs-renderer-v16...

    3 年前
  • npm 包 rancher-api-store 使用教程

    什么是 Rancher? Rancher 是一种用于部署和管理容器化应用程序的开源平台。Rancher 可以管理 Kubernetes、Mesos、Docker 的 Swarm 模式等集群,并提供 G...

    3 年前
  • npm 包 ng-fiscroll 使用教程

    简介 ng-fiscroll 是一个 AngularJS 模块和服务指令,可用于创建快速且流畅的 iOS 式滚动效果。它将 ISCroll 5 的细节封装在 Angular 的指令中,提供了双向绑定、...

    3 年前
  • npm 包 react-native-map-xz 使用教程

    介绍 react-native-map-xz 是一个基于 React Native 开发的地图组件库,它使用高德地图作为底层地图服务。通过 react-native-map-xz,我们可以在 Reac...

    3 年前
  • NPM包z-http-router使用教程

    前言 在前端开发中,我们经常需要构建Web应用程序。而在构建Web应用程序过程中,路由是一个非常重要的概念,它负责处理HTTP请求并决定返回响应内容。z-http-router正是一个非常好用的路由器...

    3 年前
  • npm 包 breakapp 使用教程

    简介 breakapp 是一个前端开发工具,用于在调试时快速中断页面的渲染,以帮助开发者更好地定位问题。它可以轻松地集成到你的项目中,提供简单易用的接口和快捷键。 安装 使用 npm 安装: --- ...

    3 年前
  • npm 包 bad-words-relaxed 使用教程

    在开发 Web 应用的过程中,经常需要进行一些文本过滤处理。而 bad-words-relaxed 则是一个专门用于敏感词过滤的 npm 包,它能够帮助我们快速、准确地过滤出文本中的敏感词。

    3 年前
  • npm 包 color-util 使用教程

    前言 在前端开发领域中,颜色是非常基础的概念,几乎所有的 Web 界面都需要使用颜色。随着前端技术的发展,使用 JavaScript 处理颜色已经成为了一个非常常见的需求。

    3 年前
  • npm包vue-token-fixed使用教程

    在开发前端项目的过程中,常常会使用Vue.js作为JavaScript框架来进行开发。在使用Vue.js时,我们都会遇到处理Token认证等相关的问题。今天,我们就来介绍一个有用的npm包 – vue...

    3 年前
  • npm 包 clipster 使用教程

    在前端开发中,我们经常需要处理文字内容,其中一个常见的需求就是将一段文字复制到剪贴板中,以便用户进行粘贴。而 npm 包 clipster 就是为了解决这一需求而生的。

    3 年前
  • npm 包 es6-menu-aim 使用教程

    在前端开发过程中,我们常常需要使用一些基础组件和库来完成网页的构建。今天我们来介绍一个方便、易用的 npm 包,它的名字叫做 es6-menu-aim。这个包可以让我们轻松地实现一个菜单栏的悬停效果,...

    3 年前
  • npm 包 medium-posts 使用教程

    什么是 medium-posts? medium-posts 是一个 npm 包,用于实现通过 Medium API 查找和检索 Medium 稿件的功能。它提供了一种简单而强大的方法来搜索和获取这些...

    3 年前

相关推荐

    暂无文章