MarkDown语法简要汇总笔记

标题

  1. setext形式即用底线形式:最高级标题(=),二级标题(-)任何数量的‘=’和‘-’效果一样。

这是一级标题 ========
展示方式:
这是一级标题
=======

  1. atx形式:在行首插入1~6个'#',分别对应1~6级标题(行尾的‘#’与效果无关)。

# 这是一级标题 #
展示方式:

这是一级标题

区块引言

  1. 在MD文件中建立一个区块引言,看起来像是强迫断行,然后在每行最前面加‘>’,并且可循环套用。:

> 区块引言文本1
> > 子区块引言文本2
展示方式:

区块引言文本1

子区块引言文本2

  1. 区块引言也允许在整个段落的第一行最前面加上‘>’:

> 这是个段落 段落中的详细文本。 blablabla。
展示方式:

这是个段落
段落中的详细文本。
blablabla。

  1. 区块引言中亦可使用其它MD语法,包括标题、清单、程式等:

> ## 二级标题
>
> 1. 有序列表1.
> 2. 有序列表2
>
> 代码实例:
>
> return shell_exec("echo $input | $markdown_script");
** 展示方式: **

二级标题

  1. 有序列表1.
  2. 有序列表2

代码实例:

return shell_exec("echo $input | $markdown_script");

清单

_ MD支持有序列表无序列表。_

  1. 无序列表使用*+-作为清单标记。(混用亦可)

* red
+ Green
- blue
** 展示方式: **

  • red
  • Green
  • blue
  1. 有序列表使用数字接着一个英文句点

1. Bird
2. McHale
3. Parish
** 展示方式: **

  1. Bird
  2. McHale
  3. Parish

可以让MD文件的清单数字和输出的结果一致,也可不一致,即随意输入数字;

建议从1.开始,因为MD未来可能会有序列表的start属性。

  1. 关于清单列表的缩排:
  • 清单标记通常放在最左边,其实亦可缩排,最多3个空白,但标记后面一定要接着至少一个空白tab
  • 清單項目可以包含多個段落,每個項目下的段落都必須縮排4個空白或是一個tab
  • _在行首出现不预知的数字-句点-空白情况,可以在句点前加反斜杠\\避免。 _

* 这是第一行文本。
(加3个空白或者tab)这是第二行文本。
** 展示方式 **

  • 这是第一行文本。
    这是第二行文本。
  1. 清单内引用区块引言,则>需要缩进:

* 在清单中内置区块引用:
(空白或tab) > 需要缩排
** 展示方式: **

  • 在清单中内置区块引用:

    > 需要缩排

  1. 如果要放程式区块的话,该区块引言就要缩排2次,即8个空白2个tab:

* 列表中放入代码:
(2个tab或8个空白缩进)代码在这里
** 展示方式: **

  • 列表中放入代码:
    NSLog(@"hello world");

代码区块

  1. 代码或者标识语言原始码写作通常已经有排版好的区块。故我们并不希望它以一般段落文本的方式去排版,而是原样输出即可。
  2. MD自动会用
    标识来将代码块包起来。
  3. _在程式碼區塊裡面,&、<和>會自動轉成HTML實體,這樣的方式讓你非常容易使用Markdown插入範例用的HTML原始碼,只需要複製貼上,再加上縮排就可以了,剩下的Markdown都會幫你處理,
  4. 在MD中建立代码区块,只要简单的** 缩排4个空白1个tab即可。 **_ (一个代码块会一直持续到没有缩排的那一行) _ :

下面是个代码区块展示:
(4个空白或1个tab)NSLog(@"hello world") ;
**展示方式: **
下面是个代码区块展示:
NSLog(@"hello world") ;
NSLog(@"hello china") ;

    _ 附录:程式碼區塊中,一般的Markdown語法不會被轉換,像是星號便只是星號,這表示你可以很容易地以Markdown語法撰寫Markdown語法相關的文件。_

分割线

  1. 可在一行中用3个或者以上的*-_来建立一个分割线,但行内不能有其它元素。
    _亦可在*中间插入空白,均可建立分割线。
  2. 本示例以及下文中的MD原始语法,均以代码块的形式展示
 * *   *
 ***
 ***********
 --      --
 -*_
 ____

**展示方式: **





-*_


区段元素

  1. MD支持2种形式的链接语法:行内链接参考链接
  2. 链接的文字均是用[链接文字]来标识。
  行内链接
  这是 [示例1](http://www.baidu.com/ "title") inline link.
 [示例2](http://www.baidu.com/)没有title属性。

 连接同主机的资源,可以使用相对路径:
 点击关于 [About](/about) 查看详情。

 参考形式的链接:
 1. 使用另外一个[]接在链接文字的方括号后面,而在第二个[]里面要填入用以链接的标签。
 2. 然后在文件的其它任意处,把[id]标签链接内容定义出来。

 这是个 [参考链接][1] 的链接。
 定义[id]
 [a]:  http://www.baidu.com  "title"

** 展示方式: **
这是 示例1 inline link.
示例2 无title属性。

点击关于 About 查看详情。

这是个 [参考链接] [a] 的链接。
[a]: http://www.baidu.com "title"

强调

  1. MD使用*_作为标记强调字词的符号。符号和文本之间不留空白
 **`\*\*` 号展示着重文本形式**
 _ `_`号展示斜体文本形式 _

 **`\*\*` 号展示着重文本形式**
 __`\_\_`号展示着重文本形式__

** 展示方式: **

\*号展示斜体文本形式

\_号展示斜体文本形式

\*\* 号展示着重文本形式

\_\_号展示着重文本形式

代码

  1. 若要标记一小段行内代码,可以用\`号将其包起来:
 文本中间有代码:`NSLog(@"hello world");` 的MD标识方式。

** 展示方式: **

文本中间有代码:NSLog(@"hello world"); 的MD标识方式。

图片

  1. 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] [id]
[id]: url/to/image "title"
** 展示 **
! [alert text] [a]
[a]: url/to/image "title"

其他

  1. 自动链接(MD支持简短的自动链接,以处理网址和email地址)
 

**展示: **
http://www.baidu.com

邮箱:

** 展示: **

跳脱字元

  1. MD可以利用 \来插入一些在语法中有其它意义的符号。如将*号置于文字旁边显示强调效果:
 \*  这是个显示强调效果的文本。 \* (此处无效果,待查)

** 展示 **
*这是个显示强调效果的文本。*

Markdown支援在下面這些符號前面加上反斜線來幫助插入普通的符號:

 \   反斜線
 `   反引號
 *   星號
 _   底線
 {}  大括號
 []  方括號
 ()  括號
 #   井字號
 +   加號
 -   減號
 .   英文句點
 !   驚嘆號

附:

  • 本文参考自 Markdown 语法说明 。
  • 本文仅是参考文档的缩略版,方便自己快速查找语法的使用。随着自己不断的运用md工具,本文将不断积累。

你可能感兴趣的:(MarkDown语法简要汇总笔记)