Markdown 使用教程

编写向导

腾讯云开发者实验室的教程使用 Markdown 作为基本的编辑语法,下面是语法概述:

  • 引用内容(通过 > 开头的段落)不会被渲染。
  • 二级标题(通过 ## 开头的段落)会作为教程的任务,一个教程可以定义多个任务
  • 二级标题下的正文内容会作为任务的概要
  • 三级标题(通过 ### 开头的段落)会作为任务下的步骤,每个任务至少包含一个步骤
  • 可以在步骤中通过指令定义教程中的任务时间、超链接、解释气泡、视频内容、文件定位、实例代码等,具体可参考上方工具栏提示或者阅读下面的示例内容。

基础内容


<time>10min ~ 20min</time>

使用二级标题定义教程任务。每个任务的概要说明可以在开始编写任务步骤之前通过正文的形式给到。

定义步骤

通过三级标题定义任务下的步骤。三级标题下的正文内容为步骤的内容。

使用小标题和列表

一个任务步骤里面允许存在若干个小标题、段落、列表的随机组合

小标题

四级标题可作为步骤小标题使用。

列表

使用数字加点的形式定义有序列表:

  1. 列表应该自动编号
  2. 列表不能和步骤列表产生视觉混淆

使用星号加点的形式定义无序列表:

  • 无序列表
  • 注意星号和内容之间要有一个空格

超链接

正文中会出现超链接标签,点击可打开连接。超链接定义的方式有下列几种:

  • 通过 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">
这个气泡内容比较丰富,这个段落比较长,因为要显得这个气泡内容很多,所以我可能会在重复一遍:
这个气泡的内容比较长,下面还会有列表,以及超链接。

  1. 接下来的步骤有点啰嗦
  2. 打开冰箱
  3. 大象放到冰箱里
  4. 把大象拿出来
  5. 给大象量体温
  6. 回到三国时期找[曹冲][http://baike.baidu.com/item/曹冲]
  7. 让曹冲称一下大象的重量
  8. 重复上述步骤,得出大象温度和大象重量之间的关系
  9. 注意,上面的曹冲是个超链接
    </bubble>

支持插入图片内容, 如:

image

视频内容

使用 video 标签可以插入视频内容,通过[腾讯视频][http://v.qq.com/u/upload.html]上传视频,上传后可以获取到 vid, 如:

  • [腾讯云 - 连接一切][video]

<video for="video" platform="qq" vid="p01578c394j" name="腾讯云 - 连接一切"></video>

使用环境变量

<time>1min</time>

环境变量获取

教程编写时,可以获取实验室环境变量,包括:

  1. 当前进行实验的云主机 IP 地址
  2. 为用户分配的实验密码

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>

恭喜

您可以开始编写您的实验教程了!

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 202,905评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,140评论 2 379
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,791评论 0 335
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,483评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,476评论 5 364
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,516评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,905评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,560评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,778评论 1 296
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,557评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,635评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,338评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,925评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,898评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,142评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,818评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,347评论 2 342

推荐阅读更多精彩内容

  • 1、通过CocoaPods安装项目名称项目信息 AFNetworking网络请求组件 FMDB本地数据库组件 SD...
    阳明先生x阅读 15,967评论 3 119
  • 在译制片式微的年代,有一个观影群体被忽视已久,他们就是我们的父母以及所有上了年纪的电影观众。 每到周末和传统节日,...
    五亭快餐面阅读 185评论 1 1
  • 我决心再一次捡起每日写文的习惯,我以为,随着岁月的蹉跎,我会没有时间没有耐心去写文字。而这几日真心体会到了...
    雨点儿飞阅读 321评论 0 1
  • 工欲善其事,必先利其器! 大家在看到这个题目的时候,是不是有点晕。作者你想表达个撒? 不知道大家有没有遇到过这样的...
    _奔波儿灞_阅读 1,080评论 0 0
  • 文/sure_培西 图/自拍 180429 听说红山动物园有新成员加入了——可爱的考拉! 平时经常带娃去考拉大冒险...
    sure培西阅读 733评论 0 0