Markdown 是一种易读易写的纯文本的语言格式,而且很方便转换为 HTML 格式。这里总结下它的基本语法规则。
1. 段落和换行
Markdown 的各个段落用一个或多个空行来分开,段落内部的换行将解释为一个空白。
2. 标题
Markdown 中用 # 号包含起来的文本是标题,# 号的个数对应标题的层次,即 <h1> 到 <h6>
3. 列表
无序列表的各项可以用 * 号,+ 号或者 - 号来表示。例如:
* Red * Green * Blue
有序列表的各项用数字加句点来表示。例如:
1. Red 2. Green 3. Blue
4. 代码区块
用反引号包括的文本将被转换为 <code> 标签,而缩进 4 个空格或一个 Tab 的段落将被转换为 <pre> 标签。例如下面的 Markdown 文本
Run the following `abc` function function abc() { alert(1); } will get an alert window.
将被转换为如下的 HTML 代码
<p>Run the following <code>abc</code> function</p> <pre><code>function abc() { alert(1); } </code></pre> <p>will get an alert window.</p>
5. 链接
链接的文本用方括号包含,链接的网址用圆括号包含。例如下面的文本:
This is [an example](http://example.com/ "Title") inline link.
将被转换为如下的 HTML 代码:
This is <a href="http://example.com/" title="Title">an example</a> inline link.
6. 图片
图片的使用和链接类似,只是前面多了个 ! 号。例如下面的 Markdown 文本
![Alt text](/path/to/img.jpg "Optional title")
将被转换为如下的 HTML 代码:
<img alt="Alt text" src="/path/to/img.jpg" title="Optional title">
参考资料:
[1] Daring Fireball: Markdown
[2] Markdown 语法说明 (简体中文版)
[3] Markdown 中文基础教程文档
[4] Markable.in - A remarkable online markdown editor
[5] textbeta - Home
[6] Online Markdown Editor - Dillinger, the Last Markdown Editor ever
[7] EpicEditor - An Embeddable JavaScript Markdown Editor
[8] Qute for PC/Mac - text editor with Markdown and TeX support