npm 包 gitbook-plugin-termtabs 使用教程

阅读时长 3 分钟读完

简介

gitbook-plugin-termtabs 是一个 GitBook 插件,用于在书籍中创建类似于终端标签页的展示形式,以便于展示与命令行相关的代码及示例。

本文将详细介绍如何使用 gitbook-plugin-termtabs 插件,以及其具有的指导意义和学习深度。

安装

使用 npm 进行安装,将 gitbook-plugin-termtabs 添加到书籍项目的依赖中即可。

使用方法

1. 引入插件

在 GitBook 项目中的 book.json 文件中添加插件依赖,例如:

2. 配置插件

插件需要在 blocks 配置块中进行配置,此外还可以通过 language 配置相关代码语言。

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

可以配置的参数说明如下:

参数 类型 说明
titles array 选项卡的标题,数组类型,包含每个选项卡的名称
eval array 选项卡的执行代码,数组类型,包含每个选项卡对应的执行代码
expected array 选项卡的预期输出,数组类型,包含每个选项卡对应的预期输出结果
language object 语言配置,包含 "eval" 和 "expected",其中 "eval" 为执行代码的语言,"expected" 为预期输出的语言

3. 创建选项卡

在需要展示终端标签页的页面中,使用 termtabs 块包裹选项卡。

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

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

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

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

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

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

选项卡标题和代码块需要使用 {% title %}{% endtitle %} 定义,同时需要嵌套在 {% termtabs %}{% endtermtabs %} 之间。

示例代码

一个使用 gitbook-plugin-termtabs 插件的示例代码如下:

{% endtitle %}

{% title "启动本地服务" %}

{% endtitle %} {% endtermtabs %}

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

-- ---------

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

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

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

- ------------------------------------------------------------------------------ --------
------------------------------------------------------------------------------------------------------------------------
纠错
反馈