什么是 Markdown?
Markdown 是一种文本格式。你可以用它来控制文档的显示。使用 markdown,你可以创建粗体的文字,斜体的文字,添加图片,并且创建列表 等等。基本上来讲,Markdown 就是普通的文字加上 # 或者 * 等符号。
语法说明
标题
# 这是 <h1> 一级标题
## 这是 <h2> 二级标题
### 这是 <h3> 三级标题
#### 这是 <h4> 四级标题
##### 这是 <h5> 五级标题
###### 这是 <h6> 六级标题
如果你想要给你的标题添加 id 或者 class,请在标题最后添加 {#id .class1 .class2}。例如:
# 这个标题拥有 1 个 id {#my_id}
# 这个标题有 2 个 classes {.class1 .class2}
这是一个 MPE 扩展的特性。
强调
*这会是 斜体 的文字*
_这会是 斜体 的文字_
**这会是 粗体 的文字**
__这会是 粗体 的文字__
_你也 **组合** 这些符号_
~~这个文字将会被横线删除~~
列表
无序列表
- Item 1
- Item 2
- Item 2a
- Item 2b
有序列表
1. Item 1
1. Item 2
1. Item 3
1. Item 3a
1. Item 3b
添加图片
![GitHub Logo](/images/logo.png)
Format: ![Alt Text](url)
链接
https://github.com - 自动生成!
[GitHub](https://github.com)
引用
正如 Kanye West 所说:
> We're living the future so
> the present is our past.
分割线
如下,三个或者更多的
---
连字符
---
星号
---
下划线
行内代码
我觉得你应该在这里使用
`<addr>` 才对。
代码块
你可以在你的代码上面和下面添加` ````来表示代码块。
语法高亮
你可以给你的代码块添加任何一种语言的语法高亮
例如,给 ruby 代码添加语法高亮:
```ruby
require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html
```
会得到下面的效果:
require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html
代码块 class(MPE 扩展的特性)
你可以给你的代码块设置 class
。
例如,添加 class1 class2
到一个 代码块:
```javascript {.class1 .class}
function add(x, y) {
return x + y
}
```
代码行数
如果你想要你的代码块显示代码行数,只要添加 line-numbers class
就可以了。
例如:
```javascript {.line-numbers}
function add(x, y) {
return x + y
}
```
将会得到下面的显示效果:
function add(x, y) {
return x + y
}
高亮代码行数
你可以通过添加 highlight 属性的方式来高亮代码行数:
```javascript {highlight=10}
```
```javascript {highlight=10-20}
```
```javascript {highlight=[1-10,15,20-22]}
```
任务列表
- [ ] @mentions, #refs, [links](), **formatting**, and <del>tags</del> supported
- [ ] list syntax required (any unordered or ordered list supported)
- [ ] this is a complete item
- [ ] this is an incomplete item
表格
First Header | Second Header
------------ | -------------
Content from cell 1 | Content from cell 2
Content in the first column | Content in the second column