在进行前端开发时,有时需要在 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 上创建一个仓库,并将仓库链接设置在插件配置文件中。
安装与配置
安装该插件很简单,只需要运行以下命令即可:
npm install gitbook-plugin-github-issue-feedback-language-custom
安装完成后,在 Gitbook 的配置文件 book.json
中添加以下内容:
-- -------------------- ---- ------- - ---------- - --------------------------------------- -- ---------------- - ---------------------------------------- - ------- ----------------------- - - -
其中,repo
表示你的 Github 仓库链接,例如 https://github.com/username/repo
。
页面中添加按钮
在需要添加 Github 问题反馈按钮的页面,使用以下语法即可:
{% github_issue_feedback %}
语言自定义
如果你需要更改 Github 问题反馈窗口中的提示语言,可以使用以下配置:
-- -------------------- ---- ------- - ---------------- - ---------------------------------------- - ------- ------------------------ ----------- - -------- ------- ------------- ---------- ------------ --------------- --------------- ----- --------------- ---- - - - -
在 language
对象中,你可以按照自己的需要修改各个属性的值,从而实现语言自定义功能。
示例代码
以下代码展示了如何同时设置仓库链接和自定义语言:
-- -------------------- ---- ------- - ---------------- - ---------------------------------------- - ------- ----------------------------------- ----------- - -------- ------- ------------- ---------- ------------ --------------- --------------- ----- --------------- ---- - - - -
{% github_issue_feedback %}
总结
本文介绍了如何使用 gitbook-plugin-github-issue-feedback-language-custom
npm 包来向页面中添加 Github 问题反馈按钮,并实现语言自定义功能。使用该插件可以方便地为用户提供问题反馈功能,提升用户体验,并让开发者更快更准确地了解用户的需求。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6005722381e8991b448e8503