npm 包 rengar-gitment 使用教程

在前端开发中,我们经常需要在网站或者博客上添加评论功能。而使用 Gitment 可以轻松地在你的网站上添加评论系统。这篇文章将为大家详细介绍如何使用 npm 包 rengar-gitment 来快速搭建 Gitment 评论系统。

什么是 Gitment

Gitment 是 GitHub 官方推出的一款基于 GitHub Issues 的评论系统。它的优点在于无需后端服务器,评论数据托管在 GitHub Issues,使用简单,便于管理和维护。

rengar-gitment

rengar-gitment 是一个基于 Gitment 的封装组件,可以更加方便地在 Vue 项目中使用 Gitment。它提供中文界面、多主题、多语言支持等等功能。使用 rengar-gitment 可以让我们更加轻松地使用 Gitment,快速搭建出一个漂亮的评论系统。

安装

安装 rengar-gitment 非常简单,只需要在项目目录下执行以下命令即可:

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

使用

在安装了 rengar-gitment 之后,我们需要在 Vue 组件中引入它:

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

接下来,我们需要在组件中添加 Gitment 组件,并传入需要的参数:

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

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

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

其中,options 是必传参数,表示 Gitment 配置项。title 表示需要评论的页面的标题。labels 表示 GitHub Issues 的标签,用于区分其他 Issues。theme 和 language 分别表示评论界面的主题和语言。

示例代码

安装 Gitment

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

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

安装 rengar-gitment

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

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

结语

通过使用 rengar-gitment 可以节省我们配置 Gitment 的时间,同时也能够使项目有更好的可维护性。希望本文能对大家有所帮助。

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


猜你喜欢

  • npm 包 @citizenos/stream_upload 使用教程

    最近,@citizenos/stream_upload 这个 npm 包备受关注。该包主要用于向文件上传流上传文件。在本文中,我们将学习如何使用这个包。 什么是 @citizenos/stream_u...

    3 年前
  • npm 包 jsdoc-webpack4-plugin 使用教程

    如果你正在编写 JavaScript 库或构建了一个 Node.js 应用程序,那么文档化是非常重要的。文档化可以帮助其他开发人员理解你的代码库,并更快地进行开发。

    3 年前
  • npm 包 kaiquecruz-cordova-plugin-chrome-apps-sockets-udp 使用教程

    前言 在前端开发中,我们经常会需要在不同设备之间进行数据传输。而 UDP 协议是一种面向无连接的传输层协议,具有简单、快速和高效的特点。本文将介绍 npm 包 kaiquecruz-cordova-p...

    3 年前
  • npm 包 react-native-template-re-base-test 使用教程

    在 React Native 的开发中,我们经常需要用到模板来加快应用的开发速度。react-native-template-re-base-test 是一个非常流行的模板,它大大减少了应用的开发难度...

    3 年前
  • npm 包 watch-typing 使用教程

    前言 在前端开发过程中,经常需要使用一些第三方库。而这些库的升级和安装可能经常会出现问题。为了方便管理,npm 包管理器应运而生。npm 是一个管理前端依赖包的工具,它可以使我们在开发时更加方便地管理...

    3 年前
  • npm 包 @batteryincluded/ts-eventsourcing 使用教程

    背景 在现代的大型应用程序中,通过事件驱动架构实现的事件溯源(Event Sourcing)模式变得越来越流行。它强制开发人员将所有状态变更视为事件,并记录下这些事件,而不是直接将更改写入数据库。

    3 年前
  • npm 包 lycwed-cordova-plugin-clipboard 使用教程

    前言 在前端开发中,我们常常需要实现复制与粘贴的功能。Cordova 插件 lycwed-cordova-plugin-clipboard 提供了实现这些功能的解决方案。

    3 年前
  • npm包 kofi-body 使用教程

    在前端开发中,经常需要对页面进行布局,而布局又需要用到各种不同的HTML元素。kofi-body就是一个方便的npm包,可以帮助我们快速构建HTML页面的布局。 kofi-body简介 kofi-bo...

    3 年前
  • npm 包 nuxt-base 使用教程

    什么是 nuxt-base nuxt-base 是一个基于 nuxt.js 的前端脚手架,它提供了一个现代化,结构合理的前端项目基础架构,帮助开发者快速搭建基于 Vue.js 的 Web 应用程序。

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

    一、前言 在大型 Web 应用开发中,我们经常需要进行 A/B 测试,以了解用户喜好,优化页面设计或功能等。而在实现 A/B 测试时,我们通常需要使用到一些工具。其中,npm 包 abtest-uti...

    3 年前
  • npm 包 Browser-img-resize 使用教程

    简介 Browser-img-resize 是一个轻量级的浏览器端图片压缩 npm 包,它使用 JavaScript 编写,能够帮助前端开发人员快速压缩图片,从而提高网站的性能和用户体验。

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

    前言 在前端开发中,如何处理 API 数据是一个非常重要的问题。API 返回的数据通常都是 JSON 格式的数据,但是这些数据并不总是符合前端的需求。因此,需要使用一些工具对数据进行转换和处理,这样才...

    3 年前
  • npm 包 kofi-cors 使用教程

    在前端开发中,网站的前端界面通常需要和后端服务器进行交互。而在跨域请求时,由于浏览器的安全限制,会导致请求失败。为了解决这个问题,我们可以使用 npm 包 kofi-cors,来帮助我们处理跨域请求。

    3 年前
  • NPM 包 Nelson-editor 使用教程

    在前端开发中,文本编辑器是一个必不可少的工具。而 Nelson-editor 是一个优秀的文本编辑器,可以帮助开发者提高编码效率。本文将为大家详细介绍如何使用 Nelson-editor。

    3 年前
  • npm 包 react-stepzilla-tt 使用教程

    介绍 React Stepzilla TT 是一个非常好用的 React 步骤向导组件,可以帮助我们轻松地创建完整的多步骤表单并管理步骤之间的导航。 React Stepzilla TT 是基于 St...

    3 年前
  • npm 包 web-extension-webpack-plugin 使用教程

    在前端开发中,我们经常需要开发浏览器插件,而 webpack 是前端开发中使用最广泛的构建工具之一。而 web-extension-webpack-plugin 就是一个可以将 webpack 构建好...

    3 年前
  • npm 包 criticli 使用教程

    在前端开发中,我们经常需要进行代码审查并进行代码评估。为了更高效地进行代码审查,我们可以使用 npm 包 criticli 来快速地进行代码质量评估和问题检测。 本篇文章将详细介绍如何使用 npm 包...

    3 年前
  • npm 包 raster-grid 使用教程

    前言 在前端开发中,经常会用到图片的处理和展示。虽然有时候我们需要高清的图片来提高网站的美观度,但是这也可能导致图片太大而加载缓慢。raster-grid 就是用于帮助我们解决这个问题的一个 npm ...

    3 年前
  • NPM包——json-lorem使用教程

    在前端开发中,经常需要用到一些假数据作为测试和开发之用,这时候 json-lorem 这款 npm 包就显得尤为重要。它可以帮助我们快速生成各种各样的 JSON 格式的假数据。

    3 年前
  • npm 包 generator-ts-node-aws 使用教程

    在前端领域,使用 npm 包来管理项目依赖已经非常普遍了。而对于 TypeScript 开发者来说,generator-ts-node-aws 这个 npm 包可以帮助我们更快捷地搭建 TypeScr...

    3 年前

相关推荐

    暂无文章