Markdown 的设计哲学
Markdown 的目標是實現「易讀易寫」。
不過最需要強調的便是它的可讀性。一份使用 Markdown 格式撰寫的文件應該可以直接以純文字發佈,並且看起來不會像是由許多標籤或是格式指令所構成。
Markdown 的語法有個主要的目的:用來作為一種網路內容的寫作用語言。
标题
Markdown 语法:
1 | # 第一级标题 |
效果如下:
第一级标题
第二级标题
第三级标题
强调
Markdown 语法:
1 | *这些文字会生成`<em>`* |
效果如下:
这些文字会生成<em>
这些文字会生成<u>
这些文字会生成<strong>
这些文字会生成<strong>
换行
四个及以上空格加回车。
列表
无序列表
Markdown 语法:
1 | * 项目一 无序列表 `* + 空格键` |
效果如下:
- 项目一 无序列表
* + 空格键
- 项目二
- 项目二的子项目一 无序列表
TAB + * + 空格键
- 项目二的子项目二
- 项目二的子项目一 无序列表
有序列表
Markdown 语法:
1 | 1. 项目一 有序列表 `数字 + . + 空格键` |
效果如下:
- 项目一 有序列表
数字 + . + 空格键
- 项目二
- 项目三
- 项目三的子项目一 有序列表
TAB + 数字 + . + 空格键
- 项目三的子项目二
- 项目三的子项目一 有序列表
列表中嵌入代码块语法
项目一 有序列表
数字 + . + 空格键
列表中嵌入代码块必须前后空一行,如这个写法1
2
3
4
5function fancyAlert(arg) {
if(arg) {
$.facebox({div:'#foo'})
}
}其他文本。
项目二
任务列表(Task lists)
Markdown 语法:
1 | - [ ] 任务一 未做任务 `- + 空格 + [ ]` |
效果如下:
- 任务一 未做任务
- + 空格 + [ ]
- 任务二 已做任务
- + 空格 + [x]
图片
Markdown 语法:
1 |  |
链接
Markdown 语法:
1 | <example@example.com> |
效果如下:
区块引用
Markdown 语法:
1 | > 第一行引用 |
效果如下:
第一行引用
第二行费用文字
行内代码
Markdown 语法:
1 | 两个行内代码`<addr>` `code` |
效果如下:
像这样即可:<addr>
code
顺序图或流程图
Markdown 语法:
请参考:http://bramp.github.io/js-sequence-diagrams/, http://adrai.github.io/flowchart.js/
表格
Markdown 语法:
1 | 第一格表头 | 第二格表头 |
效果如下:
第一格表头 | 第二格表头 |
---|---|
内容单元格 第一列第一格 | 内容单元格第二列第一格 |
内容单元格 第一列第二格 多加文字 | 内容单元格第二列第二格 |
删除线
Markdown 语法:
1 | 加删除线像这样用: ~~删除这些~~ |
效果如下:
加删除线像这样用: 删除这些
分隔线
以下三种方式都可以生成分隔线:
1 | *** |
效果如下:
MathJax
Markdown 语法:
1 | 块级公式: |
效果如下:
块级公式:
$$ x = \dfrac{-b \pm \sqrt{b^2 - 4ac}}{2a} $$
\[ \frac{1}{\Bigl(\sqrt{\phi \sqrt{5}}-\phi\Bigr) e^{\frac25 \pi}} =
1+\frac{e^{-2\pi}} {1+\frac{e^{-4\pi}} {1+\frac{e^{-6\pi}}
{1+\frac{e^{-8\pi}} {1+\ldots} } } } \]
行内公式: $\Gamma(n) = (n-1)!\quad\forall n\in\mathbb N$
脚注(Footnote)
Markdown 语法:
1 | 这是一个脚注:[^sample_footnote] |
效果如下:
这是一个脚注:^sample_footnote
注释和阅读更多
Markdown 语法:
1 | <!-- comment --> |
注 阅读更多的功能只用在生成网站或博客时,插入时注意要后空一行。
目录
Markdown 语法:
1 | [TOC] |