1. Markdown是什么
Markdown 是一种用来写作的轻量级“标记语言”,用简洁的语法代替排版。
从内容到格式,从图片到链接,甚至公式和代码,统统搞定。
以Word为代表的文档编辑器叫做富文本编辑器。
Word总体上来说还是以一种传统印刷的思维方式来定义页面和排版。
2. Markdown格式的优点
专注高效
专注于文字内容,而不是把精力花在排版上面。
- 全部内容都可以用键盘完成,不需要频繁切换鼠标操作。
- 虽然图形化界面方便了人们的日常操作,但进行大量内容编辑时,键盘更为高效。
兼容性强
纯文本格式,兼容性强。
- 在不同的编辑器内效果统一,文档转换无丢失。特别适合于网络发布和共享。
- 大家应该都经历过在几个Word文档之间拷贝粘贴内容,然后来回调格式就把自己搞崩溃的经历。Markdown不会产生这样的问题。
专业适用性
对于中短篇幅的技术类文档特别适用。
- 原文本直观可读,渲染后清晰美观。
- 支持的特性能够很好地满足技术类文档的要求。如多级标题,公式编辑,代码引用等。
对于长篇的文档,原生的Markdown在目录生成,章节自动编号方面有缺陷。但有很多插件可以支持更丰富的功能。
并且由于是纯文本格式,我们甚至可以自己编写脚本来处理,利用正则表达式的强大功能,实现特定的需求。
3. Markdown基本语法
3.1 标题
标题采用文本前加#号的方式来实现。#号后留一个空格。
# 一级标题
## 二级标题
### 三级标题
显示效果:
一级标题
二级标题
三级标题
最多支持6级标题显示。
3.2 列表
无序列表
有序列表采用文本前加-号的方式来实现。-号后留一个空格。
- 列表内容1
- 列表内容2
显示效果:
- 列表内容1
- 列表内容2
有序列表
有序列表采用文本前加数字.的方式来实现。.号后留一个空格。
1. 列表内容1
3. 列表内容2
6. 列表内容3
显示效果:
- 列表内容1
- 列表内容2
- 列表内容3
有个小细节就是前面的数字并不需要严格排序,渲染时会自动修正。
事实上全部写成
1.
也可以。
3.3 引用
从别处引用的一段话,或者需要添加备注性质的文字,可以采用引用。
引用采用在文本前加>号的方式来实现。>号后留一个空格。
> 引用的文字
显示效果:
引用的文字
3.4 字体格式
粗体
字体加粗采用文本两边用**
来标注的方式。
**加粗的文字**
显示效果:
加粗的文字
斜体
字体加粗采用文本两边用*
来标注的方式。
*斜体的文字*
显示效果:
斜体的文字
嵌套的粗斜体
***粗斜体的文字***
显示效果:
粗斜体的文字
3.5 代码
行内代码
行内代码采用文本两边用 \
来标注的方式。
void main()`
代码块
代码块采用代码前后用```
来标注的方式。
void adjustHist(Mat& src, Mat& dst)
{
vector<Mat> bgr(3);
vector<Mat> bgr2(3);
split(src, bgr);
equalizeHist(bgr[0], bgr2[0]);
equalizeHist(bgr[1], bgr2[1]);
equalizeHist(bgr[2], bgr2[2]);
merge(bgr2, dst);
}
3.6 链接与图片
插入链接
文本中插入链接的方法是[]()
。
如[百度](https://www.baidu.com/)
[]中是显示的文字。
()中是链接的url。
显示效果:
百度
插入图片
文本中插入链接的方法是![]()
。
如![图片示例](http://ooo.0o0.ooo/2015/10/22/5628736fc37d1.png)
显示效果:
图片需要事先上传到网络图床,并得到url。
也可以在文档的目录下建一个文件夹,将图片都放在其中,使用相对路径引用。
3.7 分割线
三个*号就可以添加分割线。
显示效果:
4. 推荐工具
4.1 本地编辑器
为知笔记+Wiz.Editor.md插件
为知笔记官网
Wiz.Editor.md插件,也可以在为知笔记应用中心直接下载到。
本篇说明文档就是用这个来编写的。
利用为知笔记的云端存储功能,可以实现多终端同步。用好了是一个良好的个人知识管理库。
MarkdownPad
MarkdownPad官网,一个比较老牌的Markdown本地编辑器。
Windows记事本
在手头没有其他工具的时候,不要忘了Markdown本质上就是一个纯本文格式的文档。
即使不进行预览,源文档也是有良好的可读性的,用记事本完全可以实现所有的编辑需求。
4.2 在线编辑器
我们在网上找资料的过程中,常常会搜到一些别人写的技术博客,比如:
CSDN
博客园
还有一些开源软件的托管站点,比如:
Github
开源中国
它们全部都支持并且建议以Markdown的方式来编辑文档和共享。
网友评论