Markdown 是一种轻量级标记语言,创始人为 John Gruber 。它允许人们“使用易读易写的纯文本格式编写文档,然后转换成有效的 XHTML (或者 HTML )文档”。
1 标题
标题共六级,一级标题字号最大,字号随着级别的增加递减。leanote 最多支持五级标题,可支持六级。
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题
显示效果如下:
一级标题
二级标题
三级标题
四级标题
五级标题
六级标题
2 列表
2.1 无序列表
无序列表项前的标记符号可以使用*
、+
或-
,标记符号后须加至少一个空格。
+ 无序列表项1
- 无序列表项2
* 无序列表项3
显示效果如下:
- 无序列表项1
- 无序列表项2
- 无序列表项3
2.2 有序列表
有序列表项前加上数字和一个英文句号,英文句号后须加至少一个空格。数字的大小排序不影响最终显示的效果。
1. 有序列表项 1
3. 有序列表项 2
8. 有序列表项 3
显示效果如下:
- 有序列表项1
- 有序列表项2
- 有序列表项3
注:leanote 的 markdown 编辑器,无序和有序列表前还需要添加一个空行,不需要。
3 注脚
在需要加注的文字后加上[^note]
,即可加上注脚,具体语法如下所示。注意,这里的脚注1, note2 和 footnote3 可以换成其他文字,只要前后保持一致即可。
使用 Markdown[^脚注1]可以效率地书写文档,直接转换成 HTML[^note2],你可以使用 Leanote[^footnote3] 编辑器进行书写。
(注:leanote 的 markdown 编辑器,以下各个注脚解释之间还需要用一个空行分隔,不需要)
[^脚注1]:Markdown 是一种纯文本标记语言
[^note2]:HyperText Markup Language 超文本标记语言
[^footnote3]:开源笔记平台,支持 Markdown 和笔记直接发为博文
显示效果如下:
使用 Markdown[1]可以效率地书写文档,直接转换成 HTML[2],你可以使用 Leanote[3] 编辑器进行书写。
4 插入链接
链接可指定 title 属性,也可省略。如定义了 title 属性,当鼠标悬停在链接文字上时会显示 title 属性的值。
[链接文字](链接地址 "title")
例如:[](http://www.jianshu.com/ "官网")
显示效果如下:
用<>
将链接包围起来,即自动转换成链接。
显示效果如下:
http://example.com/
[email protected]
5 插入图片
插入图片的语法为:![](图片链接 图片title)
。
- 图片 alt 是当图片无法显示时,替代图片的文字信息,可省略。
- 图片 title 是当鼠标悬停在图片上时显示的文字,可省略。
![宋民咕 鱼香肉丝里面没有肉](http://upload-images.jianshu.io/upload_images/4558002-00c60a9b78e694da.jpg?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240 "宋民咕")
显示效果如下:
6 区块引用
引用文本时,在文本前加>
即可,>
与引用文本之间需保留一个空格。
> 假如生活欺骗了你
> 不要悲伤,不要心急
> 忧郁的日子里需要镇静
> 相信吧,快乐的日子将会来临
> 心儿永远向往着未来
> 现在却常是忧郁
> 一切都是瞬息,一切都将会过去
> 而那过去了的,就会成为亲切的怀恋
显示效果如下:
假如生活欺骗了你
不要悲伤,不要心急
忧郁的日子里需要镇静
相信吧,快乐的日子将会来临
心儿永远向往着未来
现在却常是忧郁
一切都是瞬息,一切都将会过去
而那过去了的,就会成为亲切的怀恋
区块引用可以嵌套(引用内的引用),还可以在引用内使用其他的 markdown 语法,例如:
> 宋代欧阳修则云:
> 最佳读书时间,乃为三上:即**枕上**、**马上**、**厕上**。
> —— *刘真《论读书》*
显示效果如下:
宋代欧阳修则云:
最佳读书时间,乃为三上:即枕上、马上、厕上。
—— 刘真《论读书》
7 粗体、斜体、加粗斜体和删除线
具体语法如下:
1. **粗体**
2. *斜体*
3. ***加粗斜体***
4. ~~删除线~~
显示效果如下:
- 粗体
- 斜体
- 加粗斜体
删除线
8 输入代码
8.1 输入单行代码
输入单行代码的语法:`单行代码`。显示效果如下:
var a = 1
8.2 输入多行代码
输入多行代码的语法如下,在第一行的 ``` 后面加上代码语言,leanote 和都能实现语法高亮。
在每行代码前输入四个或四个以上的空格也能实现代码块的效果。
```python
class Employee:
empCount = 0
def init(self, name, salary):
self.name = name
self.salary = salary
Employee.empCount += 1
```
显示效果如下:
class Employee:
empCount = 0
def __init__(self, name, salary):
self.name = name
self.salary = salary
Employee.empCount += 1
9 表格
表格第一行为表头,第二行分隔表头与表格主体部分,第三行开始为表格主体部分。
列与列之间以|
分隔。
第二行还可为不同列指定对齐方式,|:------:|
为居中对齐,|------:|
为右对齐,|:------|
为左对齐。
|table |table |table |
|:-----|:------:|------:|
|1 |2 |3 |
|4 |5 |6 |
显示效果如下:
table | table | table |
---|---|---|
1 | 2 | 3 |
4 | 5 | 6 |
10 分隔线
输入三个以上的*
、-
和_
即可生成分隔线,*
、-
和_
之间可插入空格。
***
---
___
显示效果如下:
11 定义
如果需要对某个名词的定义作出解释,可以选用以下语法格式,目前不支持这个功能,leanote 支持。
名词 1
: 定义 1(左侧有一个冒号和四个空格)
leanote 上的显示效果如下:
12 Html 标签
leanote 支持在 Markdown 语法中嵌套 Html 标签,不支持。譬如,你可以用 Html 写一个纵跨两行的表格:
值班人员
星期一
星期二
星期三
李强
张明
王平
leanote 上的显示效果如下:
也可以通过 img 标签插入图片,利用 img 标签的 height 和 width 属性来设置图片的高度和宽度。
![](http://upload-images.jianshu.io/upload_images/4558002-73942e9b78c2b21e.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)
leanote 上的显示效果如下:
13 目录
通过 [TOC]
在文档中插入目录,暂不支持。leanote 上的显示效果如下:
14 其他
想更多地了解和学习 markdown,可参阅以下资料:
- Markdown 转换至 HTML
- Markdown 语法说明
- 时序图语法
- 流程图语法
- MathJax 公式
- leanote记数学公式
-
Markdown 是一种纯文本标记语言 ↩
-
HyperText Markup Language 超文本标记语言 ↩
-
开源笔记平台,支持 Markdown 和笔记直接发为博文 ↩