编写向导
腾讯云开发者实验室的教程使用 Markdown 作为基本的编辑语法，下面是语法概述：
- 引用内容（通过
>开头的段落）不会被渲染。- 二级标题（通过
##开头的段落）会作为教程的任务，一个教程可以定义多个任务- 二级标题下的正文内容会作为任务的概要
- 三级标题（通过
###开头的段落）会作为任务下的步骤，每个任务至少包含一个步骤- 可以在步骤中通过指令定义教程中的任务时间、超链接、解释气泡、视频内容、文件定位、实例代码等，具体可参考上方工具栏提示或者阅读下面的示例内容。
基础内容
<time>10min ~ 20min</time>
使用二级标题定义教程任务。每个任务的概要说明可以在开始编写任务步骤之前通过正文的形式给到。
定义步骤
通过三级标题定义任务下的步骤。三级标题下的正文内容为步骤的内容。
使用小标题和列表
一个任务步骤里面允许存在若干个小标题、段落、列表的随机组合
小标题
四级标题可作为步骤小标题使用。
列表
使用数字加点的形式定义有序列表：
- 列表应该自动编号
- 列表不能和步骤列表产生视觉混淆
使用星号加点的形式定义无序列表：
- 无序列表
- 注意星号和内容之间要有一个空格
超链接
正文中会出现超链接标签，点击可打开连接。超链接定义的方式有下列几种：
- 通过 URL 直接定义的[超链接][https://cloud.tencentyun.com]
- 通过[标签][label]定义的超链接，点击也可以[正常打开][label]，标签用于定义可复用的连接
教程中的超链接只允许以 http://、https:// 或 ftp:// 开头，并统一在新窗口打开。
<link for="label" href="http://console.cloud.tencent.com"></link>
高亮和代码
正文中可以出现行内的高亮内容，比如点击 开始按钮 - 关机。
使用代码块语法定义代码块，比如下面单行代码：
npm install express --save
也可能定义多行的代码：
npm install express --save
npm install co --save
使用代码块定义的代码在教程区可以方便用户快速复制。
气泡
教程编写时尽量简洁明了，辅助性的说明内容使用气泡来说明，气泡可以通过[文本激活][text]或者问号图标激活 [:question][icon]
气泡的内容也可以[很丰富][rich]。
<bubble for="text">这是文本激活的帮助内容</bubble>
<bubble for="icon">这是图标激活的帮助内容，会显示成一个问号小图标</bubble>
<bubble for="rich">
这个气泡内容比较丰富，这个段落比较长，因为要显得这个气泡内容很多，所以我可能会在重复一遍：
这个气泡的内容比较长，下面还会有列表，以及超链接。
- 接下来的步骤有点啰嗦
- 打开冰箱
- 把
大象放到冰箱里- 把大象拿出来
- 给大象量体温
- 回到三国时期找[曹冲][http://baike.baidu.com/item/曹冲]
- 让曹冲称一下大象的重量
- 重复上述步骤，得出大象温度和大象重量之间的关系
- 注意，上面的曹冲是个超链接
</bubble>
支持插入图片内容， 如：
image
视频内容
使用 video 标签可以插入视频内容，通过[腾讯视频][http://v.qq.com/u/upload.html]上传视频，上传后可以获取到 vid， 如：
- [腾讯云 - 连接一切][video]
<video for="video" platform="qq" vid="p01578c394j" name="腾讯云 - 连接一切"></video>
使用环境变量
<time>1min</time>
环境变量获取
教程编写时，可以获取实验室环境变量，包括：
- 当前进行实验的云主机 IP 地址
- 为用户分配的实验密码
IP 地址可以用于构建教程服务的 URL，如：
http://${runtime.vars.cvmIpAddress}/
开始实验的时候，会给用户分配一个随机密码（并非云主机登录密码）。分配的密码可以用于帮助用户设置服务的密码，如：
echo "${runtime.vars.allocatedPassword}"
添加实验交互
<time>10min ~ 20min</time>
定位文件和目录
教程可以添加交互点来定位文件和目录，比如：
- [定位到 /data 目录][locate_data]
- [定位到 /etc/hosts 文件][locate_hosts]
<locate for="locate_data" path="/data" hint="这是 Linux 机器数据目录，教程会定位到该目录并且高亮提醒"></locate>
<locate for="locate_hosts" path="/etc/hosts" hint="这是 Linux 静态 DNS 记录，可以定位到该文件让用户打开"></locate>
注意保证被定位的目录或文件要存在，否则将会[定位失败][locate_failed]
<locate for="locate_failed" path="/data/failed" hint="定位失败" />
打开已有文件
可以使用 edit 标签激活一个已有的文件在编辑区打开，让用户可以去编辑。比如：
- [编辑 /etc/hosts][edit-host]
<edit for="edit-host" file="/etc/hosts" />
插入示例代码
教程可以定义示例代码，示例代码可以跟机器上的某个文件关联。关联后，文件树上的上下文菜单会出现相关的关联操作，比如：
请在 /data 目录下[创建 app.js][create_appjs]，参考下面的内容。
<locate for="create_appjs" path="/data" hint="右击，创建 app.js"></locate>
/// <example verb="create" file="/data/app.js" />
function hello() {
console.log("hello");
console.log(+new Date());
}
代码对比模式
在教程区渲染的示例代码，可以以对比模式打开，会对比服务器上关联的文件。如：
现在请[编辑 app.js][edit_appjs]，参考修改如下：
<locate for="edit_appjs" path="/data/app.js" hint="双击修改 app.js，并打开对比模式"></locate>
/// <example verb="edit" file="/data/app.js" />
function hello() {
console.log("hello world");
console.log(+new Date());
}
对比模式对比的参考内容会跟当前步骤关联，可以每个步骤定义不一样的内容，引导实验者循序渐进地完善代码或配置。
注意，对比模式只会在当前步骤为激活步骤的时候才会生效。
步骤检查器
通过检查器来检查来帮助实验者确认当前步骤是否完成，丰富又准确的检查器可以带来非常好的实验体验。
现在定义一个检查器来检查机器上是不是已经存在 /data/foo 这个目录。
默认是没有这个目录的，尝试点击下一步按钮点击会提醒步骤可能还没完成。
想要通过步骤检查，可以在终端输入：
mkdir -p /data/foo
<checker type="output-contains" command="ls -la /data" hint="请先创建 foo 目录">
<keyword regex="foo" />
</checker>
教程编写学习已完成
<time>5min ~ 10min</time>
恭喜
您可以开始编写您的实验教程了！
网友评论