npm 包 gitbook-plugin-commenter 使用教程

npm 包 gitbook-plugin-commenter 使用教程

在现代 Web 开发中,Git 和 Gitbook 已经成为了必不可少的工具。其中,Gitbook 可以将 Markdown 格式的文档转换为精美的电子出版物,同时也支持评论功能。如果想在自己的文档中加入评论功能,可以使用 npm 包 gitbook-plugin-commenter。

下面是 gitbook-plugin-commenter 的使用教程,包括安装、配置和使用方法。

安装

首先,需要确保已安装 Gitbook。如果没有安装,可以使用以下命令进行安装:

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

接下来,可以通过以下命令安装 gitbook-plugin-commenter:

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

配置

在 Gitbook 的配置文件 "book.json" 中添加以下内容:

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

其中,"repo" 是你的评论存储在 GitHub 的仓库,"prefix" 和 "suffix" 是评论提交时的前缀和后缀。你需要先创建一个存储评论的 GitHub 仓库,然后在这里填写仓库地址。同时,也可以为评论添加前缀和后缀,以方便快速区分评论。

使用

添加 comments 插件后,会在每个页面的底部显示一个评论框。用户只需要在框中填写评论,并点击 "提交" 按钮,就可以将评论提交到 GitHub 上。

在提交评论前,需要先在 GitHub 上创建 "issues",作为评论的存储空间。可以在仓库中的 "issues" 标签页中创建 "New issue",并填写评论内容。提交评论时,gitbook-plugin-commenter 会将评论提交到所指定的 "repo" 中创建一个新的 "issue"。

如果需要在页面中显示评论,可以使用以下代码:

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

其中,"repo" 是评论存储在 GitHub 上的仓库地址,"issue-term" 用于指定评论的范围,"theme" 是评论框的主题。

另外,gitbook-plugin-commenter 还支持以下配置:

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

"labels" 是为文章添加标签,"reactions" 是文章点赞按钮上的反应符号。可以根据需要,将其添加到配置文件中。

这就是 gitbook-plugin-commenter 的全部使用方法。通过这个插件,你可以为你的 Gitbooks 提供完整的评论和反馈功能。

希望这篇文章对你有所帮助。

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


猜你喜欢

  • npm 包 modules-values-extract-6 使用教程

    简介 在 Node.js 和前端开发中,使用模块化开发已经成为了一种标准。在模块化开发过程中,模块之间需要进行数据的传输和处理,而 npm 包 modules-values-extract-6 就是一...

    3 年前
  • npm包electron-redux-connector使用教程

    随着前端技术的不断更新和迭代,越来越多的开发者开始将其目光投向了桌面应用程序的开发。而 electron 是一款可以跨平台开发桌面应用程序的工具包,它是由 GitHub 开发的开源工具,并凭借着其强大...

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

    前言 随着 React 技术的日益发展,越来越多的 React 组件库被开发出来并发布到 npm 上。在这些组件库中,react-liu 是一个优秀的组件库,它提供了许多常用的 React 组件以及对...

    3 年前
  • npm 包 dyna-react-component-showcase 使用教程

    在前端开发中,我们经常会使用各种组件库。但是,如何更好地展示和使用这些组件呢?这时候,我们就需要使用一个可以方便展示组件的工具,这个工具就是 dyna-react-component-showcase...

    3 年前
  • npm 包 shapesjs 使用教程

    shapesjs 是一个轻量级的 JavaScript 库,旨在帮助前端开发者在网页上创建各种形状和图形。在这篇文章中,我们将深入介绍如何使用此 npm 包来创建您自己的形状和图形。

    3 年前
  • npm 包 snowframework-action 使用教程

    背景 snowframework-action 是一个基于 snow framework 的前端开发框架,用于快速构建 SPA(单页应用)项目。该框架提供了一套完整的前端项目架构,包括路由管理、状态管...

    3 年前
  • npm 包 neat-rr 使用教程

    简介 neat-rr 是一款专门针对前端项目中自适应布局问题的 npm 包,支持解决常见自适应布局问题并提供多种可选参数。 安装及使用 安装 neat-rr --- ------- ------- ...

    3 年前
  • npm 包 tweet-counter 使用教程

    简介 tweet-counter 是一个用于计算 Twitter 话题热度的 npm 包。该包通过统计一段时间内 Twitter 上特定话题的推文数量及互动指标,并计算出该话题的热度可用于数据分析及其...

    3 年前
  • npm 包 down-the-rabbit-hole 使用教程

    在前端开发中,我们经常需要用到各种 npm 包来帮助我们实现一些功能。其中,down-the-rabbit-hole 是一个非常强大的 npm 包,它可以帮助我们深入了解 JavaScript 语言的...

    3 年前
  • 使用 hugo-webpack-boilerplate 实现前端快速开发

    前言 随着前端技术的快速发展,我们的关注点也从简单的 HTML、CSS 和 JavaScript 转变成了越来越复杂的工具链和构建环境。今天,我们将介绍一个用于快速开发的前端工具:hugo-webpa...

    3 年前
  • npm 包 censorify_ggf 使用教程

    简介 censorify_ggf 是一款能够将文字中的敏感词汇进行屏蔽或替换操作的 npm 包。这款 npm 包可以在前端领域中使用,提供了简洁易用的 API 接口,方便开发者集成到自己的应用中。

    3 年前
  • npm 包 lilyasteroid 使用教程

    简介 lilyasteroid 是一个专门为前端开发者设计的 npm 包,它提供了一系列实用的工具函数和组件,可以帮助开发者更加高效地完成项目开发。本篇文章将详细介绍 lilyasteroid 的使用...

    3 年前
  • npm包 `react-router-redux-saga-model` 使用教程

    react-router-redux-saga-model 是一个基于 React,React Router,Redux 和 Saga 的前端开发框架。它提供了一种可重用的数据管理和路由解决方案,能帮...

    3 年前
  • npm 包 pertestimate 使用教程

    什么是 pertestimate? Pertestimate 是一个基于 PERT(Program Evaluation and Review Technique)算法的 npm 包,用于估算软件开发...

    3 年前
  • npm 包 webtorrentify-github-release 使用教程

    随着前端技术的不断发展,越来越多的项目需要前后端分离架构,同时在前端开发中也有更多的复杂性。而这时,npm 包就成为了一个不可或缺的工具,可以大大提高开发效率和质量。

    3 年前
  • npm包query-logentries使用教程

    Logentries是一款实时日志管理工具,它支持将日志数据推送到云端,从而实现更方便的日志监控和分析操作。node.js封装了logentries的API,并将其作为一个npm包query-loge...

    3 年前
  • NPM 包 true-noop 使用教程

    简介 许多时候我们需要在代码中使用一些空函数,这些函数由于不需要具体的实现,因此往往只是返回空值。此时,true-noop 是一个非常有用的 NPM 包。 true-noop 提供了一种轻量级的实现,...

    3 年前
  • npm 包 zt123123somepackage 使用教程

    在前端开发中,npm 是一个非常常用的包管理工具,通过 npm 可以安装各种开源库、框架和工具,以提高开发效率。在这篇文章中,我们将介绍一个叫做 zt123123somepackage 的 npm 包...

    3 年前
  • npm 包 parallax_color_bars 使用教程

    前言 在现代 Web 开发中,滚动视差效果是一种广泛应用的设计趋势。这种效果给人带来了一种立体、逼真的感觉,使得页面显得更加生动有趣。parallax_color_bars 是一个基于 npm 的滚动...

    3 年前
  • npm 包 ngx-json-to-xlsx 使用教程

    在前端开发中,我们常常需要将数据导出为 Excel 文件。ngx-json-to-xlsx 是一个可以将 JSON 数据导出为 Excel 文件的 npm 包,使用它可以轻松地实现数据的下载和分享。

    3 年前

相关推荐

    暂无文章