GitBook 是一款非常流行的电子书写作工具,而 gitbook-plugin-simpletabs 则是其中的一款插件,它可以为 GitBook 增加一个选项卡功能,使得文章的可读性、可操作性都得到了提升。在本篇文章中,我们将介绍如何使用 gitbook-plugin-simpletabs 这个 npm 包。
安装 gitbook-plugin-simpletabs
要使用 gitbook-plugin-simpletabs 这个插件,前提是需要先安装 GitBook。如果还没有安装 GitBook,可以通过以下命令进行安装:
npm install gitbook-cli -g
安装好 GitBook 后,切换到需要增加选项卡的 GitBook 项目中,输入以下命令安装 gitbook-plugin-simpletabs:
npm install gitbook-plugin-simpletabs
安装完成后,在 GitBook 项目的根目录下会生成一个新文件夹 node_modules,里面包含了新安装的插件。
配置 gitbook-plugin-simpletabs
在 GitBook 项目的根目录下,找到 book.json 文件,增加如下代码:
{ "plugins": ["simpletabs"] }
这就是简单的插件配置,我们只需将插件名称添加到"path"设置,指明其应用路径。
为了方便使用 gitbook-plugin-simpletabs 这个插件,我们可以使用下面这种形式进行配置:
{ "plugins": ["simpletabs"], "simpletabs": { "selector": "p:contains('[tab]')", "groupHeader":"h2" } }
上述代码中,"selector"指定了使用哪种标记语言来标识选项卡。这里我们使用了 “[tab]” 来进行标记,而"groupHeader"则指定了选项卡头部使用哪种标记语言。
使用 gitbook-plugin-simpletabs
使用 gitbook-plugin-simpletabs 插件非常简单,只需要在文章中加入 "[tab]" 来标记选项卡,同时在选项卡头部加入相应的标识符即可。下面是一个示例:
[tab] # 第一项标签 这里是第一项标签的内容。 [tab] # 第二项标签 这里是第二项标签的内容。
当我们在浏览器中查看该文档时,会发现文本被自动转换成了带选项卡的形式,而且这个选项卡具有很好的交互性和可视性。
总结
至此,我们已经学习了如何使用 gitbook-plugin-simpletabs 这个 npm 包对 GitBook 做选项卡增强功能。对于需要增加选项卡的 GitBook 用户,这个插件无疑会给他们带来很大的便利。我们希望本教程能够帮到您,让您更好地使用 GitBook,并在写作过程中更加得心应手。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6005671f81e8991b448e38a9