一、命令集合
Markdown是一种纯文档标记语言,在编写文章的时候,会通过符号来对文本进行相应的排版,例如:粗体、斜体、删除线、代码块、颜色等,同时乐述云享还支持插入图片、流程图、音视频、高德地图、倒计时等元素及组件。
Markdown之所以没有普及,很大一个原因就是因为其排版使用的都是标记符号。而乐述云享为了解决这一问题,为编辑器提供了一个命令集合弹窗,将所有可用指令都可视化集中在一起,您可以通过按下快捷键F1/在菜单栏中找到命令集合按钮,来打开弹窗。
二、基础指令
基础指令主要由常用Markdown指令组成,包含:标题、超链接、分割线、列表、引用、代码、表格以及分页符组成,除了通过命令集合弹窗,还可以使用快捷键来快速使用指令。
01 标题1~6
标题是文章中用于概括和归纳文章内容的重要元素。 在编写文章时,合理的标题格式可以帮助读者更好地理解文章结构,提高阅读效率,使文档层次分明。
乐述云享支持用户使用六级标题,显示效果如下所示:
当你确定需要使用对应的标题格式时,点击对应指令,在弹出的弹窗中输入标题即可。
输入标题,点击确定,会在文本框光标处自动插入标题语法,例如:
可以看到编辑器中的标题其实就在文字前面加入了相应数量的#,就可以设置出1~6级标题样式,这里要注意#和标题中间要使用空格隔开。
因此了解到这个特点后,你也可以不再使用命令集合去设置标题了,而是直接在编辑器中使用该语法即可。
同时,该语法还具备快捷键:Ctrl + 1 ~ 6,选中一段文字/直接按下快捷键,就可以快速添加标题了。
标题的特殊用法
当你通过该语法设置标题后,进入文档预览界面,你会发现在文档左上角位置,会显示一个大纲悬浮按钮,点击后,就会根据文档标题,显示大纲目录。
若使用移动端设备查看该文档,大纲目录可以通过顶部悬浮菜单查看。
我们将上面的菜单称之为引导目录,引导目录在Markdown文档中非常重要,因为Markdown文档是支持分页的,读者可以通过引导目录快速跳转到对应的页面,而无需通过上一页/下一页来翻找需要的内容。
此处我们将基础指令中的不同指令进行了分页,你可通过引导目录,进行快速跳转。
引导目录生成规则
引导目录并不需要作者进行配置,而是根据文档的标题设置自动生成的,需要注意的是,引导目录并不会把所有标题都生成出来,其只会生成出二级目录,因此需要了解一下其生成规则。
例如:
结果:
不参与引导目录生成规则的标题设置
还有用户不希望生成引导目录,可以通过以下语法设置标题:
若通篇文档都没有标题,或者使用上述方式设置的标题,则引导目录悬浮按钮会自动隐藏。
02 超链接
超链接是一种允许我们同其他网页或站点之间进行连接的元素。
相信大家平时在浏览其他网页的过程中,会时不时遇到“点击图片、文字就跳转到其他页面”、“点击文章末尾的往期推荐就会跳转到其他网页”等情况。
其实呢,这些文字和图片之所以能够实现跳转,就是因为他们添加了超链接。这样不仅能够让读者进行文章内容的连续性阅读,而且还能为其他网页增加更多的曝光量。
若需要使用超链接,您可以在基础指令中点击超链接组件;
输入链接标题和链接地址后,点击确定按钮,会在文本框光标处自动插入超链接语法;
效果:乐述云享
超链接的语法是由一组中括号以及一组小括号组合而成. 语法说明:[超链接文本](链接地址),其中,超链接文本可以嵌套其他语法。 使用技巧:可以先选中文本再使用超链接命令。
快捷键:Ctrl + L
当网址链接比较长的时候,直接写在正文中会比较影响作者观感,因此超链接还提供了一种高级链接语法,可以将超链接文本与网址分开写,通常会将网址放置在文末,具体语法如下:
白名单
注意:为了防止出现网络诈骗/读者被导流到不安全的网站中,凡是未在官方白名单中的网址,系统会自动将超链接加上一次跳转,以提醒用户注意网络安全。
最新白名单列表:
黑名单
黑名单的建设需要依靠每一位用户,若您发现确实有存在安全问题的网址,请第一时间通过举报表单提交该网址信息。 凡是在黑名单中的域名,将不提供跳转链接,请用户自行甄别超链接是否安全。
表单:问题网址
由于黑名单网址需要通过人工收录,若您发现在平台内出现违规违法的网址超链接,请第一时间进行举报,若官方确认该网址违反法律法规,平台会将该网址定义为违禁词,用户不得在文档中携带相关域名网址。
03 分割线
分割线可以由3个重复的-_(减号、下划线)这两个符号表示,可以不连续(即可以有空格)。
例:
效果:
04 列表
列表分为有序列表、无序列表以及任务列表,如下所示:
1)有序列表:
情况1:
情况2:
注意:在Markdown中,有序列表的顺序可以错序,在预览时,会自动修正,但是有序列表中间不能有多行空行,否则序号会重新编号。
2)无序列表:
情况1:
情况2:
注意:无序列表可以使用-、+、*来作为标记符号,但是通常连续使用同一种标记符号,代表属于一个列表元素。可以仔细观察上述两种情况的元素间隔。
3)任务列表:
任务列表共有两种状态,选中与未选中。
05 引用
引用内容、说明内容,可以在语句前面加上一个>,注意是英文状态下的右尖括号+空格。
在引用中,可以解析其他语法,例如:图片、超链接、列表等等。
06 行内标签
通过快捷键 Ctrl + K 使用行内标签组件。
行内标签示例:
效果: **行内标签**
注意:行内标签中不支持内嵌Markdown语法,因此上述案例中的加粗符号,并没有被渲染。
07 代码块
在乐述云享中共有两种类型的代码块,一种是展示型代码块,另一种是编程型代码块。
展示型代码块仅作代码展示使用; 编程型代码块指用户可以直接在代码块组件中使用平台提供的编程语言进行-软件开发。
通过快捷键 Shift + Ctrl + K 使用代码块组件。
代码块示例:
效果:
编程型代码块是展示型代码块的另一种应用,乐述云享允许用户进行P5JS以及ThreeJS应用的开发,具体教程会有专门的社群进行教学。
代码块示例:
效果:
08 表格
表格是文档中相对常用的一个组件,如果你有简单的表格需求,可以使用此方法创建,但是如果您对表格有更高的需求,推荐使用第三方提供的云表格。
填写相应的表格参数,点击确定,会在编辑器中生成如下代码:
可以在该代码内填写相关内容,完成表格的内容填写,下方提供一个案例:
注意:表格内禁止使用的语法有,区块引用、列表、标题等,不推荐将第三方组件内嵌在单元格内,显示效果较差。
09 分页符
我们可以利用分页功能让用户在最短的时间内获得最有效的信息。同时也允许作者全屏展示一些组件,并通过引导菜单实现快速换页的效果。
根据提示信息,我们还需要在文档末尾的超链接区域前,加入相关补充语法,否则分页中的图片将无法正常显示。