npm 包 rengar-gitment 使用教程

阅读时长 5 分钟读完

在前端开发中,我们经常需要在网站或者博客上添加评论功能。而使用 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

纠错
反馈