2019-07-08

使用Markdown

关于Markdown

Markdown是一种非常流行的轻量级标记语言,它通过非常简单的语法,帮助作者在双手不离开键盘的前提下,做出具备漂亮排版的内容。Markdown文档以md为拓展名,但实际上是纯文本的,可以用记事本直接打开编辑。里面不光有内容,还有#, -, $等标记符号。这些符号标记定义了相应内容的呈现形式,这种呈现方式是规范化且受到广泛支持的,已经有很多软件和网站支持Markdown的渲染和显示,此外将md文件导出为html网页和pdf用于发布、分享和打印也很容易做到。

Markdown的哲学是让写作者专注于码字,而在排版上花最少的时间。大家惯用的Word软件,在打字的过程中通常需要配合大量的鼠标操作来改善文档内容的展示效果。而如果直接使用记事本写纯文本内容,写起来是快了,格式又过于单调阅读起来很费劲。Markdown很好地解决了这个问题,只需要在文本里加上简单的标记符号,从文本高亮到插入图片,就都可以通过键盘快速实现。不管是写文章还是写简历,它都堪担重任。

Markdown工具

Markdown写作工具很多。网页版的客户端的Windows的Mac的都茫茫多,此外很多博客网站都支持Markdown直接写作。

这里推荐一下微软的良心之作Visual Studio Code (VS Code)。这款好评如潮的代码编辑器拓展性很高,装上Markdown All in One之类的插件就可以在上面创建md格式文件用Markdown写博文了。它有标记高亮、错误提示和效果预览等功能,可以左边写右边实时查看排版效果,也可以一键导出为html网页或pdf文件等。

image

另外Jupyter notebook中也可以将代码块转为Markdown标注,详见Python食用方式:Jupyter notebook

Markdown语法

不要被标记语言的“语言”两个字吓到了,Markdown的语法非常简单,只需要在常规文本内容特定位置加上标记即可(标记和文字之间一个空格)。这些标记在支持Markdown的网站和软件中会被翻译成格式。

  1. 标题/大纲级别(heading)

在文字开头加上#号就可以将该文字定义为标题,具体级别由#号的数量确定,共分一到六级,例如:

前面一个#是一级标题

前面三个#三级标题

前面六个#是六级标题
  1. 加粗和斜体

加粗和斜体可以用星号*或英文下划线_放在文字前后实现:加粗前后都用两个,斜体前后都用一个。例如:

两个星号围起来加粗
两个下划线围起来也是加粗
单个星号围起来斜体
单个下划线围起来也是斜体

之所以*和_都可以,是为了应对两者组合的情形,可以用英文双下划线来加粗,单星号来标记斜体,例如:

这群粗体字里有个是

  1. 列表(list)

列表分有序列表和无序列表。

  • 有序列表(ordered list)

有序列表的实现只需要在前面加代表顺序的数字和英文点号,例如:

  1. 第一条
    blahblahblah
  2. 第二条
    blahblah
  • 无序列表(unordered list)

在文字前加 - 号(推荐,也可用加号)可以将内容设定为前面带点号的无序列表,例如:

  • 这是前面放了减号的无序列表
    blahblah
  • 这是前面放了加号的无序列表
    blahblahblah
  1. 引用

引用(如本文开头段落)的符号是英文的大于号(>),在段落开头加上这个符号就转为前面有根竖线的引用框了。例如:

子曰:抄我的前面要加>

  1. 插入链接和图片

插入链接的语法示例(这里因为说明需要用中文符号避免被Markdown翻译,使用时中括号和小括号换成英文的):

【名称】(地址)

插入图片只是前面多个叹号(同样使用时需要换成英文符号):

!【名称】(地址)

示例:

地址:Bing

图片:
i_love_markdown.png
  1. 表格

Markdown里表格规则也很简单,边框用管道符号 | 表示,然后用小短杆-(三个以上)来区分表头和表主体,每列短杆前后用英文冒号(:)来定义该列对齐方式:不加留空默认左对齐,只加在右边右对齐,左右都加居中。

但写下来还是比较累人的。直接举网上的例子(这里用无序列表注释避免内容被Markdown翻译以重现语法,真正使用时需去掉所有点号):

  • | Tables | Are | Cool |
  • | ------ |:-------:| -----:|
  • | col 3 is | right-aligned | $1600 |
  • | col 2 is | centered | $12 |
  • | zebra stripes | are neat | $1 |

写的时候只要边框(管道符号 |)数目对得上,并不需要对齐,Markdown会自动对齐边框。去掉注释后效果:

Tables Are Cool
col 3 is right-aligned $1600
col 2 is centered $12
zebra stripes are neat $1
  1. 代码框

Markdown还支持插入代码框并且可以实现语法高亮,只需要前后各加 ` 符号(反引号/重音号,英文名backtick/backquote/grave accent,键盘上数字键1左边)将代码框起来就可以实现,单个表示内嵌在文本中,三个表示独立作为代码块,并且加上代码语言以实现相应的语法高亮,如下面的书写方式:

我们中间有个code,不要让它跑了。

单词code被反引号前后引起来了。

再比如以下语句

code

在Markdown中效果是这样的:

# python code in markdown
print('hello, markdown')
  1. 分割线

欲加入分割线,使用三个星号,如:

image.png

的效果为:

未完,下面的分割线只是个例子。


  1. 删除线

用双波浪符号前后围起内容会给该部分文字加一条删除线,比如:

Not Good

  1. 公式

Markdown支持LaTex数学公式和符号,用美元符号$围起来即可,比如我们写(单个美元符号为内嵌行内公式,两个则独占一行):

math

效果如下:

利用公式y=\sum_{i=1}^n g(x_i)可得:
z=\sum_{i=1}^n f(x_i)

小结

Markdown是值得一试的写作利器,非常容易上手,常用的Markdown标记符号十个都不到,几篇文章练下来,绝对熟练了。另外需要指出的是,Markdown是为了快速排版设计的,是兼顾码字效率、可读性和易用性的折衷方案,所以其它排版软件里的一些功能比如设置字体颜色等不在Markdown的考虑范围之内。

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

推荐阅读更多精彩内容