Docable：Markdown中的识字Runbook和互动教程

Docable将从Markdown文件创建交互式笔记本。Docable的工作原理是将标记文件转换为交互式单元格，这些单元格可以运行、编辑和共享。

这导致了标记文件的识字编程环境。Markdown文件保持100%兼容，并在GitHub等上正常呈现。如果处理得当，Docable可以让您设计和构建交互式教程、交互式教育和培训材料，以及简单的基础设施Runbook。

Docable是在研究了600多个在线教程并发现导致学习者体验不佳的问题后设计的。我们设计了几个额外的功能，为教程考生和作者解决这些问题。

最常见的问题之一是教程要求用户在服务器上编辑文件的方式繁多且不一致。可记录的文件单元格负责创建路径、设置文件权限和所有者以及填充可变内容-只需单击一下即可。

要创建笔记本，只需创建一个markdown文件并在代码块上提供一些注释。

还可以在命令上提供特殊注释，从而提供更好的体验，例如自动检测平台以启用/禁用单元执行。

Docable有不同的连接器可在不同类型的环境下运行。使用下拉菜单选择环境。

Docker：如果有正在运行的docker服务，Docable可以创建一个容器来运行操作。

SSH：可以针对本地或远程创建的任何虚拟机。您可以在http://localhost:3000/targets，上使用配置新的SSH连接，然后在笔记本的下拉菜单中选择。

对于敏感变量，如密码、令牌和ssh密钥，这些变量可以存储在服务器上，并且在输出中显示时会被屏蔽。

您可以在http://localhost:3000.上与您的Documable笔记本进行交互。您可以设置Port=4000以使用不同的地址。

您也可以直接运行，这将在当前目录中提供笔记本。您可以使用notebook_dir=<；path>；更改此设置。

如果您在MacOS上使用GIP有问题，请参阅此设置/重新安装CommandLineTools的简单指南。

如果更新现有存储库，请确保运行npm update&；&；npm install以从模块获取更新。

特权：请求管理员shell的权限-对本地安装很有用。仅在本地连接中受支持。

权限：设置文件的权限，使用chmod('；u+x'；，'；700'；)支持的给出的任意格式。

使用围栏信息字符串第一部分中的内容语言执行内容。支持：JS。如果需要另一种语言，请创建问题！

平台：仅当连接到给定平台时才允许执行单元。支持：Win32、达尔文、Linux。

变量：单元格内容中引用的变量的逗号分隔列表。在单元格块内，使用{{VARIABLE_NAME}}。