易读易写的 MarkDown

2023-01-08 更新

文本

段落由一行或多行连续的文本组成,段落前后要有一行以上的空行。 如果某行只包含空格和制表符,那么该行也是空行。因此普通段落不应该用空格和制表符来缩进。

被单个 *_ 包起来的字词会被倾斜,被两个 *_ 包起来的字词会被加粗。 *_ 两边不能有空白。

星号、加号、减号都可以作为无序列表的列表标记。 注意列表标记后面有空格或制表符。 列表项目内的引用的 > 也需要缩进。

有序列表的列表标记建议全部写 1. ,方便以后调整顺序。

单行三个以上的星号、减号、底线可以建立分隔线。行内不能有其他东西。星号或减号中间允许有空格。

代码

行内小段代码直接用反引号 ` 包起来。

`hello, world!`

缩进 4 个空格或 1 个制表符就可以建立代码区块,代码区块会一直持续到没有缩进的一行或文件末尾。列表项状态下需要输入两个制表符才能建立代码区块。

代码区块中一般的 MarkDown 语法不会被转换,因此你可以很容易地以 MarkDown 语法撰写 MarkDown 语法相关的文本。

可以用多个反引号来开启和结束代码区块。使用 3 个代码符号包起来并附注代码语言,效果更佳。

网址

行内式网址链接:

This is [an example](http://example.com/ "Title") inline link.
[This link](http://example.net/) has no title attribute.

参考式网址链接:

This is [an example][id] reference-style link.
[id]: http://example.com/  "Optional Title Here"

参考式网址链接的网址也可以用尖括号。

链接标签是 不区分大小写 的字母、数字、空白和标点符号,它的定义可以放在任何地方。链接标签允许省略,此时链接标签等同于链接文字。

I get 10 times more traffic from [Google][] than from [Yahoo][] or [MSN][].

[google]: http://google.com/       "Google"
[yahoo]:  http://search.yahoo.com/ "Yahoo Search"
[msn]:    http://search.msn.com/   "MSN Search"

用尖括号包起来的网址和邮箱会被自动转成链接。 MarkDown 会先转换一次编码来糊弄邮箱搜集机器人,即使不能全挡下来,也比啥都不做强。

<http://example.com/>

图片

行内式图片链接:

![](/path/to/img.jpg)
![](/path/to/img.jpg "Optional title")

参考式图片链接:

![Alt text][id]
[id]: url/to/image "Optional title attribute"

到目前为止, MarkDown 还不能指定图片的宽高。

表格

:-: 居中 :- 左对齐 -: 右对齐

到目前为止, MarkDown 还不能合并单元格,需要借助 HTML 才能实现。