npm 包 gitbook-plugin-terminal 使用教程

阅读时长 5 分钟读完

前言

在现代 Web 开发中,Terminal 相关的功能越来越重要。然而,通过命令行方式学习技术有时候可能比较枯燥乏味,许多人宁愿看到一些互动界面。

这正是集成终端插件在 GitBook 中的流行所在。这个 npm 包 gitbook-plugin-terminal 就是其中最受欢迎并且功能最强大的插件之一。

在本篇文章中,我们将介绍如何使用 npm 包 gitbook-plugin-terminal,以让你更好的利用 GitBook 并且将你的书籍与其结合在一起。

安装gitbook-plugin-terminal

如果你还没有安装 GitBook,首先需要全局安装它:

然后,你可以在 GitBook 项目的目录下安装 gitbook-plugin-terminal:

配置 gitbook-plugin-terminal

在 GitBook 中使用 gitbook-plugin-terminal 最简单的方法是在 book.json 文件中添加配置指令:

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

这里的 copyButtonsplatform 是是 gitbook-plugin-terminal的两个主要配置选项,下面我们对它们进行讲解:

copyButtons

该选项默认为 false,如果设置为 true,就会在 terminal 插件的输入和输出区域中添加一个复制按钮,用户可以通过它复制所需的命令或者终端输出。

platform

该选项默认是空的,如果设置该选项,需求声明平台信息。平台信息决定了其对应的“命令提示符”的名称。例如,如果平台是 Windows,那么gitbook-plugin-terminal将使用“>`符号作为命令提示符。

gitbook-plugin-terminal 的使用

现在,你已经将 gitbook-plugin-terminal 添加到你的 gitbook 项目中,并且可以配置它,接下来让我们看看如何在文档中使用它。

在章节中使用终端

最简单的方法是添加代码块后缀 terminal,如下:

当然上面的命令只是文本,如果需要在gitbook中真的执行这些命令,需要在book.json中配置terminal菜单:

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

注意事项

gitbook-plugin-terminal 的输入和输出都可以被复制。然而,如果你包含了一些特殊字符难以被复制,那么你可能需要使用相应工具手动复制。

为了避免遇到麻烦,我们建议你只复制 TextField 区域中的文本。

结语

gitbook-plugin-terminal 是一个相对简单,但非常有用的插件,可以帮助你更好的制作 GitBook 并且为用户提供更出色的阅读体验。

相信本文中的介绍,可以帮助你更好、更深入的掌握它的使用方法。欢迎你尝试一下,加入到你的GitBook 中去。

示例代码

在 gitbook 项目中添加以下代码可以在 gitbook 终端中使用:

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

纠错
反馈