npm 包 gitbook-plugin-github-issue-feedback-language-custom 使用教程

在进行前端开发时,有时需要在 Gitbook 中嵌入 Github 问题反馈,以便于用户反馈问题。本文将介绍使用 gitbook-plugin-github-issue-feedback-language-custom npm 包来实现这一功能,并提供详细的使用教程。

插件介绍

gitbook-plugin-github-issue-feedback-language-custom 是一个 Gitbook 插件,它可以向页面中添加一个按钮,用户点击该按钮可以打开一个 Github 问题反馈窗口,方便用户反馈问题。该插件在 gitbook-plugin-github-issue-feedback 插件的基础上增加了语言自定义功能,可以让用户自定义窗口中的提示语言。使用该插件需要在 Github 上创建一个仓库,并将仓库链接设置在插件配置文件中。

安装与配置

安装该插件很简单,只需要运行以下命令即可:

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

安装完成后,在 Gitbook 的配置文件 book.json 中添加以下内容:

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

其中,repo 表示你的 Github 仓库链接,例如 https://github.com/username/repo

页面中添加按钮

在需要添加 Github 问题反馈按钮的页面,使用以下语法即可:

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

语言自定义

如果你需要更改 Github 问题反馈窗口中的提示语言,可以使用以下配置:

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

language 对象中,你可以按照自己的需要修改各个属性的值,从而实现语言自定义功能。

示例代码

以下代码展示了如何同时设置仓库链接和自定义语言:

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

总结

本文介绍了如何使用 gitbook-plugin-github-issue-feedback-language-custom npm 包来向页面中添加 Github 问题反馈按钮,并实现语言自定义功能。使用该插件可以方便地为用户提供问题反馈功能,提升用户体验,并让开发者更快更准确地了解用户的需求。

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


猜你喜欢

  • npm 包 stljs-fixed 使用教程

    前言 在前端开发中,使用现有的工具和第三方库可以大大提高开发效率,加速项目进度。其中,npm 是前端工程师经常用到的包管理工具之一,它可以方便地安装、管理和升级第三方库。

    3 年前
  • npm 包 compress-assets 使用教程

    在前端开发中,我们通常会遇到一些需要压缩资源的情况,比如将 CSS、JS、图片等文件进行压缩,以减少页面加载时间和带宽消耗。而 npm 包 compress-assets 就是一款优秀的资源压缩工具,...

    3 年前
  • npm 包 jsui-revenant-ram 的使用教程

    介绍 jsui-revenant-ram 是一个前端开发工具,用于处理 JavaScript 的内存问题。它提供了一些实用的功能,包括内存释放、性能优化等。本教程将介绍如何使用这个工具,并提供一些示例...

    3 年前
  • npm 包 css-to-stylus-converter 使用教程

    在前端开发中,我们经常会使用 CSS 和 Stylus 这两种样式语言。但是,在不同的项目中,我们使用的语言也可能不同。有时候,我们需要将 CSS 转换为 Stylus,或者将 Stylus 转换为 ...

    3 年前
  • npm 包:live-cricket-scores 使用教程

    在前端开发中,我们经常需要使用外部依赖,而 npm 是一个十分流行的包管理工具。本文将介绍一款 npm 包:live-cricket-scores,它可以实现即时获取市场上的板球比分。

    3 年前
  • npm 包 ember-async-tooltips 使用教程

    简介 ember-async-tooltips 是一个为 Ember.js 框架所设计的 tooltips 插件。这个插件帮助开发者轻松地实现 tooltips,同时还支持异步加载响应式样式。

    3 年前
  • npm 包 readwrite-lock 使用教程

    在前端开发中,我们经常会遇到多线程的问题。例如,在一个页面中,多个组件需要同时读取和更新同一个数据,此时如果没有正确的处理,可能会导致数据错误。readwrite-lock 包为我们提供了一种解决方案...

    3 年前
  • npm 包 yagni-dom 使用教程

    前言 在 Web 前端开发中,操作 DOM 是最常见的操作之一。yagni-dom 是一个小巧而灵活的 npm 包,它封装了一系列 DOM 操作函数,使得操作 DOM 变得更加轻松和高效。

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

    前言 在前端开发中,我们常常需要对数据进行增删改查等操作,而操作数据时如果能使用简洁且易于维护的代码是我们一直追求的目标。本文将会介绍使用 npm 包 @hspkg/mutate 来实现数据的简单修改...

    3 年前
  • npm 包 @weus/imagemin-pngquant 使用教程

    在前端开发中,经常需要对网站的图片进行处理,使页面加载速度更快,用户体验更好。其中,压缩图片是一种常见的优化方式,而 @weus/imagemin-pngquant 正是一款 npm 包,可以帮助我们...

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

    概述 btcnano-p2p 是一个可以用于处理比特币Nano协议通信的npm包。它可帮助前端开发人员更好地理解比特币Nano协议通信,从而更好地进行开发。 在本教程中,您将了解如何使用btcnano...

    3 年前
  • npm 包 btcnano-explorers 使用教程

    简介 btcnano-explorers 是一个 npm 包,用于与比特币(Bitcoin)和纳诺比特币(Bitcoin Nano)区块链网络进行交互。它提供了一些工具,可以用来访问区块链数据,并与比...

    3 年前
  • 前端开发中的 img-blur-in npm 包使用教程

    在前端开发中,我们经常需要使用一些图片效果来增强网站的视觉效果。其中一种最常见的效果就是图片模糊。为了方便开发者快速实现这种效果,有人创建了一个名为 img-blur-in 的 npm 包。

    3 年前
  • npm 包 bs-either 使用教程

    作为前端开发人员,我们经常需要处理和管理 JavaScript 的副作用。在使用异步操作时,我们通常会面临错误处理方面的问题,例如处理回调函数的错误等。而这些问题通常可以通过 Either 类型来解决...

    3 年前
  • NPM 包 nodebb-theme-material-green 使用教程

    介绍 nodebb-theme-material-green 是一款基于 NodeBB 的 Material 风格主题,可以通过 NPM 安装并使用。这个主题以 Google Material Des...

    3 年前
  • NPM包vue-mixer使用教程

    介绍 vue-mixer是一个用于Vue.js项目的组件插件,它有助于创建复杂的布局和数据操作,例如表格、分页、筛选和排序等。此外,它还具有自适应和响应式布局,可帮助为不同的屏幕大小和设备类型提供优化...

    3 年前
  • npm 包 permalinks-date-helpers 使用教程

    前言 在前端开发中,我们经常需要将页面 URL 中的日期部分进行格式化,以满足特定的需求。而 permalinks-date-helpers 正是一个 npm 包,它提供了一些方便易用的 API 来处...

    3 年前
  • npm 包 @weus/imagemin-jpeg-recompress 使用教程

    导言 随着互联网的发展,网页的图片和多媒体资源日益丰富和复杂,对于前端性能的优化和提升扮演着越来越重要的角色。其中一个非常关键的问题是如何减小图片的体积,以便更快地加载并且占用更少的带宽。

    3 年前
  • npm 包 ember-smart-format 使用教程

    前言 在 Web 开发中,我们通常需要对数据进行格式化,以便于展示和交互。在 Ember.js 框架中,使用 Handlebars 模板语言可以轻松地完成这项工作。

    3 年前
  • npm 包:umlplot 使用教程

    简介 umlplot 是一个可以将代码中的 UML 类图生成为 SVG 文件的 npm 包。它可以对于大型的代码项目,提供一个轻便的方式来理解代码结构。在本篇文章中,我们将介绍如何使用 umlplo...

    3 年前

相关推荐

    暂无文章