下文为半撇私塾翻译自adam-p 的Markdown 小抄表,发布与Github [Markdown Cheetsheet]。
目录
标题
强调
列表
超链接
图片
代码块
表格
引用块
行内 HTML
分隔符
断行
1 | # H1 |
H1
H2
H3
H4
H5
H6
你也可以使用下划线的方式标记H1 与H2:
Alt-H1
Alt-H2
## 重点1 | 重点,又被称为斜体,在两边加上*星号* 或是_下划线_ 。 |
重点,又被称为斜体,在两边加上星号 或是_下划线_ 。
更强的重点,又称为粗体,在两边加上两个星号 或是__两个下划线__ 。
也可以用星号与_下划线_ 结合重点。
删除线使用两个波浪符号。删除这个。
(在这个例子里,前置与后面的空白以点的方式显示:⋅)
(In this example, leading and trailing spaces are shown with with dots: ⋅)
1 | 1. 第一个有序列表项目 |
- 第一个有序列表项目
- 另一个项目
- 无序子列表
实际数字不重要,只要它是一个数字
有序子列表
与其他项目
要在列表项目下加入段落,只要缩进就好了。注意前面的空白行,以及前置的空白(至少要一个空白,不过我们在这里会使用三个空白以刚好对齐原始的文字)。
要使文字段行而不会成为新的段落,你只需要在后面加上两个空白。
注意这行已经分开了,不过还是在同样的段落中。
(如果不要求后面的两个空格,就为伴了典型的GFM 断行格式。)
- 无序列表可以使用星号
- 或减号
- 或加号
有两个方法可以建立超链接
1 | [这是一个行内样式的超链接](https://www.google.com) |
或让他空白并使用超链接文字本身。
网址,或是尖括号中的网址会自动转换成超链接。
http://www.example.com 或http://www.example.com 甚至有时候example.com 也可以(只是举例,Github上无效)。
引用超链接可以在一些文字后面。
## 图片1 | 这是我们的Logo(把鼠标指向Logo 可以看到标题文字) |
这是我们的Logo(把鼠标指向Logo 可以看到标题文字)
行内样式:![]()
引用样式:![]()
代码与语法高亮
代码区块是Markdown 规格的一部分,不过语法高亮不是。无论如何,许多渲染器──如Github 和Markdown Here ──支援语法高亮。每个渲染器支援的程式语言,以及程式语言的名字写法都不一样。Markdown Here 支援几十种语言(以及不一定是真的程式语言,像diffs 与HTTP headers)的语法高亮;要看完整的列表,以及语言的名称,请见highlight.js 的示范页。
1 | 行内的`代码` 用`反引号` 包围起来。 |
行内的代码 用反引号 包围起来。
代码区块可以用只有三个反引号```的一行围起来,或是以四个空格缩排。我建议用三个反引号的方式围起来── 这比较简单,而且只有这个方式支援语法高亮。
```javascript
var s = "JavaScript 语法高亮";
alert(s);
1
2
3
4
```python
s = "Python 语法高亮"
print s
1
2
没有指定程式语言,所以没有语法高亮。
不过,我们可以放进一个<b>标签</b>。
1 | var s = "JavaScript 语法高亮"; |
1 | s = "Python 语法高亮" |
1 | 没有指定程式语言,所以Markdown Here 没有语法高亮(在Github 上可能不一样)。 |
Markdown 的核心标准没有表格,不过表格是GFM 的一部分,而且Markdown Here 支援表格。这是在电子邮件中加入表格的好方法- 本来是需要从其他应用程式复制贴上的工作。
1 | 冒号可以用来标示栏位的对齐方式。 |
冒号可以用来标示栏位的对齐方式。
| Tables | Are | Cool |
|---|---|---|
| 第三栏 | 靠右对齐 | $1600 |
| 第二栏 | 置中对齐 | $12 |
| 斑马条纹 | 是整齐的 | $1 |
每个标头元件都要用至少三个破折号分隔开来。
最外面的竖线可以省略,你也不需要让原始的文字排列整齐。你也可以使用行内样式的Markdown。
| 不 | 漂亮 | 的文字 |
|---|---|---|
| 依然 | 渲染的 |
很好 |
| 1 | 2 | 3 |
1 | > 在电子邮件中,引用文字可以很方便的模拟回应的文字。 |
在电子邮件中,引用文字可以很方便的模拟回应的文字。
这行也在同样的引用区块。
引用区块结束
## 行内HTML就算这行很长,只要包裹的好,依然可以很好的被引用。哦,我们继续写以保证每个人都确实的被包在里面。喔,你也可以在引用文字中放入 其他Markdown 语法。
你也可以在Markdown 里面撰写原始的HTML,这些HTML 一样大多数运作的很好。
1 | <dl> |
- 定义列表
- 有时候,人们偶尔会用到。
- 在HTML 中撰写Markdown
- *无法* 运作的**非常** 好。改用HTML标签。
1 | 三个或更多个…… |
三个或更多个……
连字符
星号
下划线
## 断行如果你想要学习断行如何运作,我基本上建议最好就是实验看看── 按
你可以试试看这里的一些方式:
1 | 我们从这一行开始。 |
我们从这一行开始。
两个换行符号分开了这行和前面那一行,所以这会变成分开的段落 。
这行也是个分开的段落,不过……
只有一个换行符号分开这行,所以这是同段落 中的分开两行。
(技术提示: Markdown Here 使用GFM 的换行,所以不用使用Markdown 原先的两个空格换行法。)
License: CC-BY