除了 Html 格式外,Voyager 还支持 Markdown 文档格式的文件,扩展名使用.md
。Markdown 文件格式是 轻代码 推荐的文件格式。在使用 Markdown 作为页面文件格式时,强烈建议使用母版页,以更好的控制整个页面的布局。Voyager 使用 Marker 类将 Markdown 格式转成 HTML 格式,Marker 类也可以在你自己的项目中使用。
Marker 不仅可以对标准的 Markdown 文档格式进行转换,还提供了一些扩展,可以让 Markdown 提供更多的样式和功能。本文主要介绍 Markdown 及其扩展语法。
使用 1 个到 6 个井号#
开头并接一个空格的行,表示分别表示 标题 1 到 标题 6。例如:
另外在一行文字下方加三个以上等号=
会自动将上一行转成标题 1。例如:
使用一个*
包围的文字表现为斜体,例如 斜体。使用两个*
包围的文字为粗体,例如 粗体。如果想同时拥有精体和斜体,可以使用三个星*
包围,如 粗斜体。
使用一个反引号 `
包围的文字,一般表强调。
Markdown 本身没有提供对文字字体、颜色、大小和斜体等样式的控制,Marker 扩展了 Markdown 的语法,以提供文字样式控制功能。
如上例所示,语法两个斜杠、样式部分、起分隔作用的冒号:
、分隔样式的逗号,
和文本内容组成。可控制的样式有:
Consolas
0
的整数数字,16
为默认大小。green
、yellow
等,支持的颜色及对应的编码见下表。#FF0000
,详见颜色编码表。b
表示粗体,i
表示斜体,u
表示下划线,s
表示删除线,其中下划线和删除线不能共存。/黄色背景:yellow/
。200%
.
开头的类名,如.comment
。在这种文字样式定义中,不建议再包含 HTML 标签,因为 HTML 结尾标签中包含/
,链接中的地址也包含/
,会发生识别错误。这时可以将文字样式设定分为两段。
Markdown 中的链接语法可选种类比较多,但也比较简单。
上例语法分别说明如下:
"
或单引号'
引起来。!
即可。注意这是 Marker 对 Markdown 语法的扩展。[1]
、[2]
、[3]
都是参考索引。参考索引的定义必须单独占一行,且前面不能有空格。!
即可。1
。2
。3
。插入图片的语法基本和链接相同,只不过前面加一个叹号。
语法分别说明如下:
虽然场景不多,但有时确实会用到。在图片上添加一个链接,Marker 的扩展语法如下:
其中:
!
表示在新窗口打开链接。没有必要在图片上和链接上同时加提示文字。无序列表,星号*
、加号+
和减号-
都可以。
有序列表,使用数字加一个点。
在 Markdown 中实现代码块有两种方式。第一种是方式是使用缩进,使用4
个空格开始的行自动生成代码区块,但要求代码块开始行的上一行必须为空行,结束行的下一行也必须为空行。例如:
不过这种方式不常用,没有彩色编码,可以理解为只是简单的把内容用<pre><code>
和</code></pre>
包围起来。第二种方式使用三个连续的反引号`
包围。
这种方式的优点是可以在第一组反引号之后写明代码的类型,这样转换时就会显示为彩色编码。要求第一组和第二组反引号都必须独立占一行,上例中第一组和第二组反引号之间不要写空格。当不指定代码类型时,效果同第一种方式。
为了页面美观考虑,有时我们需要上下两行之间设置一定的间隔。
以--
开始和结束,中间支持任意数字,单位是“像素”,空格是可选的。
在行内文字或组件之间,也可以使用间隔,一般用于组件之间或组件和文字之间。
以-|
开始并以|-
结束,中间支持任意数字,单位是“像素”,空格可以有可以没有。
参考链接