npm 包 gitbook-plugin-commenter 使用教程
在现代 Web 开发中，Git 和 Gitbook 已经成为了必不可少的工具。其中，Gitbook 可以将 Markdown 格式的文档转换为精美的电子出版物，同时也支持评论功能。如果想在自己的文档中加入评论功能，可以使用 npm 包 gitbook-plugin-commenter。
下面是 gitbook-plugin-commenter 的使用教程，包括安装、配置和使用方法。
安装
首先，需要确保已安装 Gitbook。如果没有安装，可以使用以下命令进行安装：
npm install gitbook-cli -g
接下来，可以通过以下命令安装 gitbook-plugin-commenter：
npm install gitbook-plugin-commenter --save
配置
在 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 还支持以下配置：
{
"pluginsConfig": {
"commenter": {
"labels": ["Gitbook"],
"reactions": ["+1", "heart"]
}
}
}"labels" 是为文章添加标签，"reactions" 是文章点赞按钮上的反应符号。可以根据需要，将其添加到配置文件中。
这就是 gitbook-plugin-commenter 的全部使用方法。通过这个插件，你可以为你的 Gitbooks 提供完整的评论和反馈功能。
希望这篇文章对你有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005625a81e8991b448df990