一、前言
Markdown是一种可以使用普通文本编辑器编写的标记语言,通过简单的标记语法,它可以使普通文本内容具有一定的格式。 --摘自百度百科
没想到一向不太靠谱的百度百科这次竟有了如此精辟的解释。之前项目一直使用word
撰写文档,有比较大的弊病:
- 只能对纯文本文件进行版本控制,而word是二进制格式
- 格式繁杂,经常需要中断写作来控制格式
- 代码与文档分离,给写文档造成更大的阻力
而假如单纯的使用txt,就没有一点格式了,用html虽然既有格式又能加入版本控制,但是需要花费较多的时间在标签上,而且标签占了文档的较大百分比,不易阅读。
所以,最终的解决方案就是 **Markdown** ,作为一种轻量级的标记语言,能在非常短的时间内掌握。而且不仅可以用于写文档,还可以写博客、写简书、做一些随手笔记。Markdown文件以.md结尾,可以导出为html和PDF(需要使用的工具支持)。它是一种语法(个人认为是简化版的html),但是和html不同的是,各种解析器对其会有不同的表现。比如我的IDEA Markdown插件会把分割线显示成一条细灰线,Cmd Markdown则是显示一条虚线。所以建议保持使用一种Markdown工具和尽量使用标准语法。
二、Markdown基本语法
1. 标题
代码:
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 最小只有六
效果:
一级标题
二级标题
三级标题
四级标题
五级标题
最小只有六
2. 加粗
代码:
**我要被加粗了**
效果:
我要被加粗了
3. 代码引用(>式)
代码:
> hello markdown!
效果:
hello markdown!
代码:
> hello markdown!
>> hello markdown!
效果:
hello markdown!
hello markdown!
4.代码引用(```式)
代码:
效果:
hello markdown!
5.代码引用(Tab式)
代码:
hello markdown!
效果:
hello markdown!
6. 插入链接(简单式)
代码:
<http://example.com>
效果:
7.插入链接(内嵌式)
代码:
[搜狗](https://www.sogo.com "搜狗一下")
效果:
8. 插入图片
代码:
![](https://upload-images.jianshu.io/upload_images/6912209-8c53b79a706bb7c2.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/273 '描述')
效果:
9. 有序列表
代码:
1. one
2. two
3. three
效果:
- one
- two
- three
10. 无序列表
代码:
* one
* two
* three
效果:
- one
- two
- three
11. 分割线
代码:
---
效果:
12. 表格
代码:
name | age | sex
:------:|:------|------:
tony|20|男
lucy|18|女
效果:
name | age | sex |
---|---|---|
tony | 20 | 男 |
lucy | 18 | 女 |
三、总结
以上所述就是Markdown的基本标签,虽然不多,但是可以解决大部分情况。
可以用20%的标签完成80%的效果
参考: