npm 包 gitbook-plugin-term 使用教程

阅读时长 3 分钟读完

介绍

有时我们在编写文档时需要插入终端命令的执行结果,但直接插入文本的形式不够直观,这时候就需要使用 gitbook-plugin-term 这个 npm 包。

gitbook-plugin-term 包能够将终端命令执行结果以动画的形式呈现在 GitBook 的页面上,可以更加生动直观地展示命令的执行过程和结果。本篇文章将详细介绍该包的使用方法,并提供示例代码。

安装

使用 npm 安装 gitbook-plugin-term

使用

book.json 文件中添加 gitbook-plugin-term 插件,在该插件下添加终端命令的相关配置:

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

以上配置中,commands 为命令行数组,可以添加多个命令。也可以通过 options 对象设置插件的参数,例如:

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

其中,options 可以设定一些插件的参数,cwd 表示路径。另外还有其他的参数选项,可以在插件的官方GitHub 页面 中查看。

示例

假设需要在 GitBook 上展示如下命令的执行结果:

在 GitBook 内容页的 Markdown 中,可以如下进行编辑:

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

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

在页面显示结果如下:

本示例代码也可在 我的 GitHub 中下载。

小结

本篇文章详细介绍了 gitbook-plugin-term 的安装和使用,包含了示例代码,希望能对你的文档编写有所帮助。该 npm 包的使用方法灵活,可以自定义命令行数组,添加、删除指令等,可以方便地将终端命令执行结果以动画方式呈现在 GitBook 页面上,使得文档更加生动和直观。

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

纠错
反馈