简介
Markdown是一种可以使用普通文本编辑器编写的标记语言,通过简单的标记语法,它可以使普通文本内容具有一定的格式。Markdown 的目标是实现“易读易写”。
用途
写文档;
写博客;
用于编写说明文档,并且以README.md
的文件名保存在软件的目录下面。
优势
Markdown的语法简洁明了、学习容易,而且功能比纯文本更强。
专注你的文字内容而不是排版样式,安心写作,效率极高。
一般与代码放在一起,不必在其他位置寻找文档
流行的博客平台都支持 Markdown
在数据科学领域,Markdown已经被确立为科学研究规范,极大地推进了动态可重复性研究的历史进程
快速将Markdown转化为演讲PPT、Word产品文档、PDF文档、HTML文档
缺点
无法满足精细化的文档格式要求
推广
在项目和插件中添加README.md
数据库设计文档
其他设计文档也建议使用
使用例子
标题
这是 H1 <一级标题>
这是 H2 <二级标题>
这是 H6 <六级标题>
文字格式
这是文字粗体格式
这是文字斜体格式
横线
列表
无序列表
- 项目1
- 项目2
- 项目3
有序列表
- 项目1
- 项目2
- 项目3
- 项目1
- 项目2
图片
链接
链接名称
引用
第一行引用文字
第二行引用文字
水平线
代码
<hello world>
代码块高亮
def add(a, b)
return a + b
end
表格
表头 | 表头 |
---|---|
单元格内容 | 单元格内容 |
单元格内容 | 单元格内容 |