npm 包 gitbook-plugin-terminal 使用教程

前言

在现代 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


猜你喜欢

  • NPM 包 karma-webdriverio-launcher 使用教程

    简介 karma-webdriverio-launcher 是一个基于 WebdriverIO 6 的 karma 浏览器启动器。它提供了一个很方便的方式来自动测试浏览器,并且支持通过多个浏览器运行测...

    2 年前
  • npm 包 promiseful 使用教程

    在前端开发过程中,经常会用到异步代码。而使用异步代码,就不可避免地要处理回调函数。为了解决回调函数导致的“回调地狱”问题,Promise 应运而生。使用 Promise 可以让异步代码更加优雅和可读。

    2 年前
  • npm 包 koa-austack 使用教程

    在前端开发中,koa-austack 这个 npm 包被广泛地用于搭建基于 Koa 的 Web 应用程序。它不仅提供了基本的中间件和路由处理功能,还可以通过插件扩展更完整的功能,例如静态资源服务等。

    2 年前
  • npm 包 schesign-js-json-schema 使用教程

    前言 在前端开发的日常工作中,我们通常会用到 JSON 数据格式来进行数据交互。而对于 JSON 数据的校验与格式化等问题,我们可以使用一个名为 schesign-js-json-schema 的 n...

    2 年前
  • npm 包 yandex-money-sdk-fixed 使用教程

    yandex-money-sdk-fixed 是一个基于 Node.js 的 npm 包,用于使用 Yandex Money REST API 进行付款和收款等操作。

    2 年前
  • npm 包 cerebro-ebay 使用教程

    前言 随着电子商务的快速发展,eBay 成为了全球最大的 C2C 平台之一。对于需要在 eBay 上进行交易或观察 eBay 商品的人来说,能够快速搜索 eBay 商品信息是很有必要的。

    2 年前
  • npm 包 spyjest 使用教程

    作为前端工程师,我们经常被要求写高质量的测试用例以保证代码的质量。而 spyjest 是一个可以帮助我们更加方便地完成单元测试的 npm 包。在本文中,我将详细介绍如何使用 spyjest 来写单元测...

    2 年前
  • npm包 biodic-webpack-starter 使用教程

    前言 前端开发需要使用很多工具来提高效率和质量,而npm是其中的一个必不可少的工具。npm是源于Node.js的包管理器,开发者可以使用npm来下载和安装其他人编写的模块,以及发布自己编写的模块。

    2 年前
  • npm 包 @marysieek/react-native-fbsdk 使用教程

    在现代的移动应用中,社交媒体平台的集成逐渐成为了必需品。Facebook SDK 提供了许多功能,例如登录、分享、广告等等。如果你正在使用 React Native 开发应用,那么你会需要一个专门为 ...

    2 年前
  • npm 包 @staltz/asyncstorage-down 使用教程

    简介 @staltz/asyncstorage-down 是一个基于 react-native 的 npm 包,可以在移动端本地存储数据,支持异步操作,灵活性高,使用方便。

    2 年前
  • npm 包 cond-table 使用教程

    如果你正在开发一个前端应用程序或者网站,并且需要展示大量的数据,那么 cond-table 可能是一个不错的选择。cond-table 是一款基于 React 的 npm 包,它可以帮助你创建可排序、...

    2 年前
  • npm 包 ezqs 使用教程

    前言 在众多的前端开发工具中,npm(Node.js 的包管理器)一直占据了重要的地位,提供了丰富的可复用的 JavaScript 模块,极大地方便了前端工程师的开发流程。

    2 年前
  • npm 包 haraka-plugin-template 使用教程

    介绍 Haraka 是一个用 JavaScript 编写的 SMTP 服务器框架。它允许我们在 Node.js 环境中构建可扩展的邮件处理系统。Haraka 的一个重要组成部分是插件系统,它允许我们添...

    2 年前
  • npm 包 json2es6m 使用教程

    随着前端开发的日益发展,我们常常需要使用 JSON 格式的数据,但是 JSON 格式的数据在使用时必须要进行转换才能在代码中使用。而在使用 ES6 的模块化语法时,我们经常需要使用 JSON 格式的数...

    2 年前
  • npm 包 main-routine-with-files 使用教程

    随着前端应用愈发复杂,前端开发人员需要处理大量的文件和代码,使得开发工作变得越来越困难和繁琐。main-routine-with-files 是一个 npm 包,旨在为前端开发人员提供一个简单且有效的...

    2 年前
  • npm 包 pkap-mongoose-intl 使用教程

    前言 随着互联网的发展和全球化,多语言已经成为一个必备的功能,而在 Node.js 项目中使用 MongoDB 的时候,pkap-mongoose-intl 就成了一个可靠的选择。

    2 年前
  • NPM包:common-to-amd使用教程

    前端开发中,经常会遇到使用不同模块化规范的情况。有时候需要将一个基于CommonJS规范的npm包转换成基于AMD规范的形式,以便在使用require.js模块加载器等工具中进行使用。

    2 年前
  • NPM 包 nodebb-theme-audioflea 使用教程

    Nodebb 是一个基于 Node.js 构建的现代化的论坛系统,拥有丰富的插件和主题。而 nodebb-theme-audioflea 是一款非常不错的 Nodebb 主题,它的特点是全面支持音频模...

    2 年前
  • npm 包 gulp-common-to-amd 使用教程

    前言 在开发前端项目的过程中,我们经常需要使用流程自动化工具来提高开发效率和代码质量。Gulp 是一个流程自动化工具,能够对 JavaScript、CSS、图片等资源进行处理、优化和打包等操作。

    2 年前
  • npm 包 sugar-router 使用教程

    前言 随着前端技术的不断发展,前端工程化越来越普及,npm 包作为前端工程化中的重要组成部分,为开发者提供了许多便利。本文就为大家介绍一个优秀的前端路由工具 sugar-router,使前端页面的管理...

    2 年前

相关推荐

    暂无文章