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

前言

在前端开发中，我们经常会遇到用户在使用我们的应用时遇到了问题，需要向我们反馈。为了更好地收集用户反馈，我们可以将问题收集到一个中央化的问题管理系统中，如GitHub issue系统。然而，为了让非技术人员也能方便地向我们反馈问题，我们需要为他们提供一个更易于使用的反馈工具。在这里，我们将介绍一个npm包，即gitbook-plugin-github-issue-feedback-language，可以方便地将用户反馈集成到你的GitBook中。

安装和使用

安装

gitbook-plugin-github-issue-feedback-language可以通过npm安装。

$ npm install gitbook-plugin-github-issue-feedback-language --save

集成到GitBook中

将gitbook-plugin-github-issue-feedback-language添加到你的GitBook插件列表的book.json配置文件中：

{
    "plugins": ["gitbook-plugin-github-issue-feedback-language"]
}

完成以上添加后，你需要添加一个特殊的markup标签到你的页面中。

{% github_issue_feedback_language %}

以上标签包含在页面中将自动添加一个“报告问题”按钮，用户单击该按钮即可报告他们在阅读时遇到的问题。问题被提交后，你将在你的GitHub存储库的Issue页面中看到它们。

配置

gitbook-plugin-github-issue-feedback-language可以配置一些参数，以满足你想要的反馈系统的需求。

{
    "pluginsConfig": {
        "github-issue-feedback-language": {
            "repo": "yourname/yourrepo",
            "labels": ["question", "help-wanted"]
        }
    }
}

以上配置示例配置了github-issue-feedback-language插件参数中的repo和labels。repo参数指定了问题提交后将被发送到的GitHub问题存储库。labels参数指定了问题的标签，以便更好地分类问题。

结论

gitbook-plugin-github-issue-feedback-language是一个可以方便地将用户反馈集成到你的GitBook中的npm包。通过使用这个npm包，你可以轻松地让用户向你报告问题，并将问题发送到你指定的GitHub存储库。同时，这个npm包也支持一些配置参数，以满足你的反馈系统的需求。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60055feb81e8991b448dda3c