npm 包 "@tdtsh/workshopper" 使用教程

阅读时长 4 分钟读完

简介

@tdtsh/workshopper 是一个基于 Node.js 的终端教程闯关工具包,可以让你轻松创建交互式的终端教程项目。

使用这个工具包可以帮助你创建更加生动有趣的教程项目,并且可以在终端环境中直接运行,帮助用户更高效的学习和掌握知识。

该工具包具有以下特点:

  • 提供了丰富的 UI 组件,可以用于创建交互式的终端 UI;
  • 提供了丰富的样式配置选项,帮助你快速的创建一个个个性化的教程项目;
  • 支持多语言,可以让你轻松的创建一个支持多语言的教程项目;
  • 完全开源,可以让你自由的扩展和修改它的功能;
  • 支持插件,可以让你轻松的扩展它的功能。

安装

在使用 @tdtsh/workshopper 之前需要先安装它,可以使用 npm 命令进行安装。

安装完成后,使用 workshopper 命令就可以进入到教程项目的列表中。

创建一个教程项目

使用 workshopper create 命令可以创建一个教程项目,执行该命令时,会提示你输入教程项目的名称。

该命令会在当前目录下生成一个 my-workshopper 的目录,并且在该目录下会有一个 workshopper.json 文件,用于配置教程项目的信息。

-- -------------------- ---- -------
-
  ------- -----------------
  -------- --- ----------- ---------
  -------------- -- ----------- ------- ------- -- -----
  ----------- -----
  -------------- ------------
  ------- -
    --------- ---
    --------- ---
    --------- --
  --
  ------- -----
  --------- -
    ----- --------
    ------- --------
    -------- ------
    ------- -------
    -------- ---------
    ------- --------
    --------- --------
    ------- ---------
  -
-
展开代码

其中,name 表示教程项目的名称;title 表示教程项目的标题;description 表示教程项目的描述信息;language 表示教程项目的默认语言;exerciseDir 表示教程项目的练习目录名称;menu 表示教程项目的菜单栏目,可以通过增减菜单项来创建想要的项目结构;repo 表示教程项目的 GitHub 仓库地址,目前还没有支持 GitHub 的功能;styles 表示教程项目界面的样式配置。

接着在教程项目的根目录下创建练习目录 exercises

在该目录下创建一个 .md 文件作为教程项目的第一个练习的内容描述。

运行教程项目

在完成教程项目的编辑后,使用 workshopper 命令启动教程项目。

然后就可以在终端界面中看到教程项目的运行效果,根据提示一步步的学习和重新执行教程代码,直到成功完成教程。

结语

通过 @tdtsh/workshopper 创建一个交互式的终端教程项目非常方便,不仅能够提供更加生动有趣的学习过程,而且也能够让用户通过直接在终端中进行交互来更好地掌握知识和技能。

如果你正在或即将开始创建一些终端教程项目,建议你尝试一下这个工具包,相信它会让你的教程项目更加生动有趣,用户体验更加良好。

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