1. 什么是Markdown?
Markdown 是一种非常简单的、轻量级的标记语言。用户可以使用简单的标记符号以最小的输入代价去生成极富表现力的文档。Markdown 的语法简洁明了、学习容易,功能比纯文本强得多,因此有很多人用它写博客、写文档。
2. Markdown优点
- 易读(看起来舒服)、易写(语法简单)、易更改(纯文本),可以方便地纳入版本控制;
- 格式转换方便,Markdown 的文本可以轻松转换为 HTML、PDF、Word、图像、Epub 等文件;
- 语法简单,没有什么学习成本,能轻松在码字的同时做出美观大方的排版。
3. 使用场景
各类代码托管平台
主流的代码托管平台,如 GitHub、GitLab、BitBucket、Coding、Gitee 等等,都支持 Markdown 语法,很多开源项目的 README、开发文档、帮助文档、Wiki 等都用 Markdown 写作。技术社区和写作平台
StackOverflow、CSDN、掘金、简书、GitBook、有道云笔记论坛
V2EX、光谷社区
4. 如何使用Markdown
Markdown基础语法主要包括以下内容:
标题、段落格式、列表、区块、代码、链接、图片、表格
4.1 标题
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题
效果:
一级标题
二级标题
三级标题
四级标题
五级标题
六级标题
4.2 段落格式
4.2.1 字体
斜体文本
粗体文本
粗斜体文本
4.2.2 分隔线
-------
*********
效果:
4.3 列表
4.3.1 有序列表
有序列表使用数字并加上 . 号来表示
1. 第一项
2. 第二项
3. 第三项
4.3.1 无序列表
无序列表使用星号(*)、加号(+)或是减号(-)作为列表标记
- 第一项
- 第二项
- 第三项
4.4 区块
区块引用是在段落开头使用 > 符号 ,然后后面紧跟一个空格符号:
区块引用
菜鸟教程
学的不仅是技术更是梦想
4.5 代码
如果是段落上的一个函数或片段的代码可以用反引号把它包起来(`),例如:printf()
``` 包裹一段代码,并指定一种语言(也可以不指定):
$(document).ready(function () {
alert('RUNOOB');
});
4.6 链接
4.7 图片
开头一个感叹号 !
接着一个方括号,里面放上图片的替代文字
接着一个普通括号,里面放上图片的网址,最后还可以用引号包住并加上选择性的 'title' 属性的文字。
[图片上传失败...(image-33f202-1563182632593)]
4.8 表格
使用 | 来分隔不同的单元格,使用 - 来分隔表头和其他行。
表头 | 表头 |
---|---|
单元格 | 单元格 |
单元格 | 单元格 |
还可以设置对齐方式:
表头 | 表头 | 表头 |
---|---|---|
单元格 | 单元格 | 单元格 |
单元格 | 单元格 | 单元格 |
5. 高级技巧
包括流程图,公式编辑器等
5. 编辑工具
理论上任何一款文本编辑器都能用于编辑 Markdown 文档,它们分别提供了不同程度的语法高亮、预览等功能,以下只是列举其中一部分,选择自己称手的即可。
现代编辑器
VSCode / Atom传统编辑器
Vim / Emacs / Sublime Text / Notepad++IDE 自带编辑器
IntelliJ IDEA / Android Studio / WebStorm专用编辑器
Ulysses / Mou / Typora / Markpad在线编辑器
各种支持 Markdown 的网站都提供了在线编辑器,CSDN、简书、有道云笔记等