Markdown的一些基本语法
使用标题
Markdown可以使用#来标示标题。一个#后面跟的内容是一级标题,一般一级标题是文章的大标题。两个#,后面跟的内容是二级标题,依次类推。正文中的标题,一般用二级标题。
下面是例子:
# 一级标题
## 二级标题
### 三级标题
得到:
一级标题
二级标题
三级标题
加粗、斜体
对指定文本进行加粗:
**文本加粗**
得到:
文本加粗
对指定文本置斜:
*文本置斜*
得到:
文本置斜
对指定文本加粗并且置斜:
***文本加粗、置斜***
得到:
文本加粗、置斜
分割线
分割线的语法:
空一行后,使用三个以上的短线、星号、或者下划线
一般在两个小节之间使用分割线。
---
***
___
上面的例子中有三个分割线生成,如下所示:
列表
列表有两种,一种是无序列表,使用一些图标标记,没有序号;一种是有序列表,使用数字标记。
无序列表
无序列表语法:
在‘-’号之后加一个空格,再跟列表项的内容。
例如:
- 苹果
- 香蕉
- 菠萝
得到:
- 苹果
- 香蕉
- 菠萝
也可以使用多级无序列表,只需要在低层列表符号之前再加一个空格。
- 水果
- 香蕉
- 苹果
- 衣服
- 大衣
- 毛衣
得到:
- 水果
- 香蕉
- 苹果
- 衣服
- 大衣
- 毛衣
有序列表
有序列表语法:
在数字和“.”号之后加一个空格,再跟列表项的内容。
例如:
1. 把冰箱门打开
2. 把大象装进去
3. 把冰箱门关上
得到:
- 把冰箱门打开
- 把大象装进去
- 把冰箱门带上
也可以使用分级,使用方法与无序列表类似:在低层列表前再加一个空格。
1. 把冰箱门打开
2. 把老虎从冰箱中拿出来
1. 给大象吃个香蕉
2. 把大象装进去
3. 把冰箱门带上
得到:
- 把冰箱门打开
- 把老虎从冰箱中拿出来
- 给大象吃个香蕉
- 把大象装进去
- 把冰箱门带上
引用
引用的语法:
在“>”符号之后跟一个空格,然后添加引用内容。
例如:
> 这是引用的文字!!!
得到:
这是引用的文字!!!
快捷键
- 加粗
Ctrl + B
- 斜体
Ctrl + I
- 引用
Ctrl + Q
- 插入链接
Ctrl + L
- 插入代码
Ctrl + K
- 插入图片
Ctrl + G
- 提升标题
Ctrl + H
- 有序列表
Ctrl + O
- 无序列表
Ctrl + U
- 横线
Ctrl + R
- 撤销
Ctrl + Z
- 重做
Ctrl + Y
表格
可以使用冒号来定义对齐方式:
| 项目 | 价格 | 数量 |
| :-------- | --------:| :--: |
| Computer | 1600 元 | 5 |
| Phone | 12 元 | 12 |
| Pipe | 1 元 | 234 |
得到:
项目 | 价格 | 数量 |
---|---|---|
Computer | 1600 元 | 5 |
Phone | 12 元 | 12 |
Pipe | 1 元 | 234 |
代码块
代码块语法遵循标准markdown代码,例如:
用```python开始和结束的```将下面的代码块包起来
@requires_authorization
def somefunc(param1='', param2=0):
'''A docstring'''
if param1 > param2: # interesting
print 'Greater'
return (param2 - param1 + 1) or None
class SomeClass:
pass
>>> message = '''interpreter
... prompt'''
得到:
@requires_authorization
def somefunc(param1='', param2=0):
'''A docstring'''
if param1 > param2: # interesting
print 'Greater'
return (param2 - param1 + 1) or None
class SomeClass:
pass
>>> message = '''interpreter
... prompt'''
脚注
生成一个脚注[^footnote].
[^footnote]: 这里是 **脚注** 的 *内容*.
得到
生成一个脚注1.
目录
用 [TOC]
来生成目录:
[TOC]
得到:
UML 图:
可以渲染序列图:
用```sequence和结束的```将下面包起来
张三->李四: 嘿,小四儿, 写博客了没?
Note right of 李四: 李四愣了一下,说:
李四-->张三: 忙得吐血,哪有时间写。
得到:
或者流程图:
用```flow和结束的```将下面包起来
st=>start: 开始
e=>end: 结束
op=>operation: 我的操作
cond=>condition: 确认?
st->op->cond
cond(yes)->e
cond(no)->op
得到:
- 这里是 脚注 的 内容. ↩