标题
setext形式即用底线形式:最高级标题(=),二级标题(-)任何数量的‘=’和‘-’效果一样。
这是一级标题
展示方式:
这是一级标题
atx形式:在行首插入1~6个’#’,分别对应1~6级标题(行尾的‘#’与效果无关)。
这是一级标题
展示方式:
这是一级标题
区块引言
在MD文件中建立一个区块引言,看起来像是强迫断行,然后在每行最前面加‘>’,并且可循环套用。:
区块引言文本1
子区块引言文本2
展示方式:
区块引言文本1
子区块引言文本2
区块引言也允许在整个段落的第一行最前面加上‘>’:
这是个段落
段落中的详细文本。
blablabla。
展示方式:
这是个段落
段落中的详细文本。
blablabla。
区块引言中亦可使用其它MD语法,包括标题、清单、程式等:
二级标题
- 有序列表1.
- 有序列表2
代码实例:
return shell_exec(“echo $input | $markdown_script”);
展示方式:
二级标题
有序列表1.
有序列表2
代码实例:
return shell_exec(“echo $input | $markdown_script”);
清单
MD支持有序列表和无序列表。
无序列表使用*、+、-作为清单标记。(混用亦可)
- red
- Green
- blue
展示方式:
red
Green
blue
有序列表使用数字接着一个英文句点:
- Bird
- McHale
- Parish
展示方式:
Bird
McHale
Parish
可以让MD文件的清单数字和输出的结果一致,也可不一致,即随意输入数字;
建议从1.开始,因为MD未来可能会有序列表的start属性。
关于清单列表的缩排:
清单标记通常放在最左边,其实亦可缩排,最多3个空白,但标记后面一定要接着至少一个空白或tab。
清單項目可以包含多個段落,每個項目下的段落都必須縮排4個空白或是一個tab
在行首出现不预知的数字-句点-空白情况,可以在句点前加反斜杠\避免。
- 这是第一行文本。
(加3个空白或者tab)这是第二行文本。
展示方式
这是第一行文本。
这是第二行文本。
清单内引用区块引言,则>需要缩进:
- 在清单中内置区块引用:
(空白或tab) > 需要缩排
展示方式:
在清单中内置区块引用:
需要缩排
如果要放程式区块的话,该区块引言就要缩排2次,即8个空白或2个tab:
- 列表中放入代码:
(2个tab或8个空白缩进)代码在这里
展示方式:
列表中放入代码:
NSLog(@”hello world”);
代码区块
代码或者标识语言原始码写作通常已经有排版好的区块。故我们并不希望它以一般段落文本的方式去排版,而是原样输出即可。
MD自动会用
和标识来将代码块包起来。
_在程式碼區塊裡面,&、<和>會自動轉成HTML實體,這樣的方式讓你非常容易使用Markdown插入範例用的HTML原始碼,只需要複製貼上,再加上縮排就可以了,剩下的Markdown都會幫你處理,
在MD中建立代码区块,只要简单的 缩排4个空白或1个tab即可。 (一个代码块会一直持续到没有缩排的那一行) :
下面是个代码区块展示:
(4个空白或1个tab)NSLog(@”hello world”) ;
展示方式:
下面是个代码区块展示:
NSLog(@”hello world”) ;
NSLog(@”hello china”) ;
附录:程式碼區塊中,一般的Markdown語法不會被轉換,像是星號便只是星號,這表示你可以很容易地以Markdown語法撰寫Markdown語法相關的文件。
分割线
可在一行中用3个或者以上的、-、来建立一个分割线,但行内不能有其它元素。
亦可在中间插入空白,均可建立分割线。
本示例以及下文中的MD原始语法,均以代码块的形式展示
展示方式:
区段元素
MD支持2种形式的链接语法:行内链接和参考链接。
链接的文字均是用[链接文字]来标识。
行内链接
这是 示例1 inline link.
示例2没有title属性。
连接同主机的资源,可以使用相对路径:
点击关于 About 查看详情。
参考形式的链接:
展示方式:
这是 示例1 inline link.
示例2 无title属性。
点击关于 About 查看详情。
这是个 参考链接 的链接。
强调
MD使用、_作为标记强调字词的符号。符号和文本之间不留空白
**`\*号展示着重文本形式**
_`号展示斜体文本形式
\*\* 号展示着重文本形式
\_\_号展示着重文本形式
展示方式:
*号展示斜体文本形式
_号展示斜体文本形式
** 号展示着重文本形式
__号展示着重文本形式
代码
若要标记一小段行内代码,可以用号将其包起来:
文本中间有代码:NSLog(@”hello world”);` 的MD标识方式。
展示方式:
文本中间有代码:NSLog(@”hello world”); 的MD标识方式。
图片
MD使用一种和链接很相似的语法来标记图片。同样也允许有2种样式:行内 和 参考。
( 目前为止,无法指定图谱安的宽高,如需要,则使用普通的 标签 )
行内:
![alet 文本] (/path/to/img.jpg)
![alet 文本] (/path/to/img.jpg “title”)
** 展示如下:
! [alet] (/path/to/img.jpg)
! [alet 文本] (/path/to/img.jpg “title”)
参考:
展示
! alert text
a: url/to/image “title”
其他
自动链接(MD支持简短的自动链接,以处理网址和email地址):
http://www.baidu.com
展示:
http://www.baidu.com
邮箱:
address@e_mail.com
展示:
address@e_mail.com
跳脱字元
MD可以利用 \来插入一些在语法中有其它意义的符号。如将号置于文字旁边显示强调效果:
\ 这是个显示强调效果的文本。 * (此处无效果,待查)
展示
这是个显示强调效果的文本。
Markdown支援在下面這些符號前面加上反斜線來幫助插入普通的符號:
\ 反斜線
` 反引號
- 加號
- 減號
. 英文句點
! 驚嘆號
附:
本文参考自 Markdown 语法说明 。
本文仅是参考文档的缩略版,方便自己快速查找语法的使用。随着自己不断的运用md工具,本文将不断积累。
链接:http://www.jianshu.com/p/f7305002a30f
來源:简书
著作权归作者所有。商业转载请联系作者获得授权,非商业转载请注明出处。