Markdown说明(留存)

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. 列表内容1
  2. 列表内容2
  3. 列表内容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的方式来编辑文档和共享。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 200,527评论 5 470
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 84,314评论 2 377
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 147,535评论 0 332
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,006评论 1 272
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,961评论 5 360
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,220评论 1 277
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,664评论 3 392
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,351评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,481评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,397评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,443评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,123评论 3 315
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,713评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,801评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,010评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,494评论 2 346
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,075评论 2 341

推荐阅读更多精彩内容