npm 包 gitbook-plugin-termtabs 使用教程

简介

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 %}

-- ---------

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

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

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

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

猜你喜欢

  • npm 包 @loai/mkt 使用教程

    简介 @loai/mkt 是一款基于 React 框架开发的前端组件库,它提供了丰富的 UI 组件和常用工具函数,可以快速帮助开发者搭建高质量的前端应用。使用 @loai/mkt 可以减少开发时间和维...

    4 年前
  • npm 包 transferto-client 使用教程

    简介 transferto-client 是一个基于 Node.js 的 npm 包,它提供了一种简单、快捷的方法来连接并与 TransferTo PAYG API 交互。

    4 年前
  • npm 包 js-laravel-validation 使用教程

    js-laravel-validation 是一款能够在前端进行 Laravel 验证的 npm 包,使用简单,能够有效的简化前端 Laravel 验证的操作流程。

    4 年前
  • npm 包——node-red-contrib-watt2kwh 的使用教程

    对于前端工程师来说,npm 包是相当重要的一部分。在本篇文章中,我们将会介绍一个有用的 npm 包:node-red-contrib-watt2kwh,希望能够帮助读者更好地了解该包的使用和其深度及学...

    4 年前
  • npm 包 lodash-template-module-loader 使用教程

    前言 在前端开发中,我们经常会遇到需要在页面渲染中使用模板的场景。这时候,我们可以使用一些开源的模板引擎库来帮助我们完成页面渲染。而 lodash-template-module-loader 就是其...

    4 年前
  • npm 包 vue-literal-compiler 使用教程

    前言 在 Vue.js 组件开发中,经常需要使用 template 字符串来定义组件的模板。Vue.js 提供了很便利的方式来实现字符串模板的编译,我们可以直接使用 Vue.js 提供的 $compi...

    4 年前
  • npm 包 react-hooks-reducer 使用教程

    前言 在 React 开发中,我们经常会用到组件状态的管理和更新。React 中的 Hook 技术可以使得组件状态的管理和更新更为简洁和直观。其中,useState Hook 可以用来管理组件状态。

    4 年前
  • npm 包 mikeporter-twig-coding-challenge 使用教程

    在前端开发中,我们经常会用到各种各样的第三方库和工具,使得我们的工作更加高效和便捷。而 npm 包则是前端开发中非常常用的资源。在本文中,我们将会介绍一个名为 mikeporter-twig-codi...

    4 年前
  • npm 包 dependencies-trace 使用教程

    在前端开发中,常常使用 npm 包管理工具来管理项目的依赖关系。而在一个较为庞大的项目中,依赖关系通常十分复杂,而且不同依赖包之间的影响关系也不容易把握。这就需要一款能够追踪依赖关系的 npm 包,如...

    4 年前
  • npm 包 react-modalized 使用教程

    React-modalized 是一个方便的 React 模态对话框库,它能够轻松构建出个性化的模态对话框,能够实现多种不同的交互模式。本篇文章旨在介绍 React-modalized 包的使用方法,...

    4 年前
  • npm 包 node-red-contrib-graphql 使用教程

    在前端开发中,GraphQL 可以说是非常重要的技术之一。它以一种比传统的 RESTful API 更加灵活和高效的方式处理数据交互。在 Node.js 中,我们可以使用一个叫做 node-red-c...

    4 年前
  • npm 包 rate-map 使用教程

    简介 rate-map 是一个可以用来统计和处理 JavaScript 数组中各项出现频次的 npm 包。它的特点是功能简单易用,而且具有丰富的参数设置和灵活性。 安装 你可以通过 npm 安装 ra...

    4 年前
  • npm 包 @alexseitsinger/react-simple-text-input 使用教程

    前言 前端开发需要用到各种库和组件,而 npm 是非常常用的一个 JavaScript 包管理工具。本文介绍的 @alexseitsinger/react-simple-text-input 是一个前...

    4 年前
  • npm 包 @1602/react-native-cached-image 使用教程

    介绍 @1602/react-native-cached-image 是一款 React Native 应用中常用的图片缓存解决方案,其中内置多种预加载策略和 LRU(最近最少使用)缓存机制。

    4 年前
  • npm 包 webpack-package-manager 使用教程

    在前端开发中,webpack 是一个常用的打包工具,而 webpack-package-manager 是一个基于 npm 的 webpack 插件管理器,可以便捷地进行 webpack 插件的安装、...

    4 年前
  • 前端新手必看:使用 ts-quick 包快速转换 JavaScript 代码为 TypeScript 代码

    是否遇到过想要将自己的 JavaScript 代码改写成 TypeScript 代码,而无从下手的情况?又或者是想用 TypeScript 写一些项目,但因为复杂的语法和繁琐的类型定义而感到困惑?不用...

    4 年前
  • Gatsby-Starter-Location-Github 使用教程

    Gatsby-Starter-Location-Github 使用教程 Gatsby 是一个快速、现代且高效的网站生成框架,它使用 React 构建静态网站。Gatsby-Starter-Locati...

    4 年前
  • npm 包 bing-image-search 使用教程

    简介 在前端开发中,经常需要使用到图片搜索,bing-image-search 是一款npm包,提供易用的API接口,能够方便快速地搜索bing搜索引擎中的图片资源。

    4 年前
  • npm 包 open-twitch-dashboard 使用教程

    介绍 open-twitch-dashboard 是一个为 Twitch 平台构建的开源仪表板,该仪表板提供了有关 Twitch 频道和用户的实时数据统计信息。该 npm 包提供了一个方便的使用界面,...

    4 年前
  • npm 包 @unplugstudio/lory-a11y 使用教程

    什么是 @unplugstudio/lory-a11y? @unplugstudio/lory-a11y 是一款基于 lory 的轮播图组件,并实现了无障碍(a11y)功能,旨在为开发者提供一个易用、...

    4 年前

相关推荐

    暂无文章