文章目录
- 1. Markdown是什么?
- 2. 为什么要用Markdown?
- 3. 怎么用 Markdown?
- 3.1 标题
- 3.2 加粗、斜体
- 3.3 引用、代码
- 3.4 列表
- 3.5 公式
- 3.6 表格
- 3.7 插入网址链接和图片
- 3.8 排版规范
- 4. 在哪用Markdown?
- 4.1 即写即显示:Typora
- 4.2 对照显示:Atom, VSCode
- 4.3 多平台协作:印象笔记
- 5. 我的 Markdown 使用经历和体会
1. Markdown是什么?
一说到 Markdown,可能你会经常听到这样一句话:
Markdown是一种轻量级的网络标记语言。
但其实只看这个定义,还是不太明白,那我们再看看 Markdown 的发明者 John Gruber 是怎么介绍的1:
Markdown 是为网络写作者提供的一种文本转换为 HTML 的工具。你可以用一种易读、易写的纯文本格式进行写作,Markdown 会将其转换成 XHTML(或 HTML )格式。
由此,我们可以简单理解为,Markdown 是一种文档编辑工具,就像使用 Word 一样。
2. 为什么要用Markdown?
看到这里,你肯定心中有疑问:既然也是一种编辑工具,那用 Word 不好吗?
请回想一下用 Word 写文章时,
- 设定标题、字号、间距、加粗等排版工作,是不是要花费大量时间?
- 如果需要插入代码,显示出来的效果是否不太理想?我们希望能像代码编辑器里一样,对函数、部分语句等突出显示,看着舒服;
- 插入网址链接,显示出一长串网址,不够简洁美观。最好能显示为链接的文字说明,点击链接就可以到达网址。
现在不用再为这些问题烦恼了,使用 Markdown 就可以完美解决。除此之外,Markdown 还有以下好处:
-
Markdown编辑器平台统一。 如果你使用过网上的写作平台,可能就会发现,在使用富文本编辑器的平台,比如豆瓣,输入文档后还需要对标题、链接等重新编辑调整一下,而支持 Markdown 编辑器的平台,比如 CSDN, 输入文档后显示比较一致,标题、加粗、链接等都是使用的统一语法,无需对内容进行二次排版编辑。
-
现在有很多工具可以帮助我们将 Markdown 文档轻松转换 pdf 或 word 文档,这样,用 Markdown 写作、轻松排版,然后转换一下,省去了很多排版编辑时间。
3. 怎么用 Markdown?
要用好 Markdown,首先要学习一下它的语法。别担心,内容不多而且好记。当然,更好的办法是在练习中掌握:你可以参考我的示例格式,自己输入内容练习几遍。在哪里练习呢?别急,下一节就会介绍编辑器的使用了,你可以先浏览一下本节内容,对 Markdown 使用有个大致印象。
3.1 标题
使用#
,几级标题就在前面加几个#
,显示效果如下图所示。这里说明一下,我采用的是对照模式,左边为编辑输入,右边为预览显示,后面的示例也是这样。
可以对比一下各级标题的字号、行间距的不同。另外,你可能会注意到,在#
与文字间有一个空格。在使用中,我发现有的编辑器要求必须有空格,有的编辑器不做要求、可以识别,因此,建议还是加一个空格。
3.2 加粗、斜体
使用*
,具体方法和显示效果如图所示:
3.3 引用、代码
引用使用>
。
行内代码显示,在代码前后使用 ` 符号(对应键盘位置为 Tab 键上方)。代码块显示,在代码前后使用 ```符号。此外,代码块前可以加上所使用的语言作为注释(比如 python),显示效果更佳。具体方法和显示效果如图所示:
有时我们需要在文章中显示运行程序的结果,这时可以采用图中所示的方式,在结果前加上 text 注释。
3.4 列表
使用-
或*
+空格的格式,具体方法和显示效果如图所示:
注意看有序列表,首先,如果我们用数字
+.
+空格
的格式输入,编辑器会识别为有序列表,后续行会自动编号。其次,如果始终输入1
+.
+空格,实际显示的效果也是顺序编号。
3.5 公式
在公式前后使用$
,可以看下图的示例,更多公式的写法可以参考网上的Latex语法。
3.6 表格
图中示例展示了表格的写法,有一点请大家注意,如果后期要进行文档转换,尤其是转换成 word ,一定要先检查一下表格能否正常转换,我就遇到过转换成 word 后显示的表格是图中左侧原始编辑格式的情况。
3.7 插入网址链接和图片
如图中示例所示,[ ]内填写文字说明,( )内填写链接地址。图片链接比网址链接前面多一个!
,图片链接的文字说明一般不显示,但是建议填写,因为有时可能图片加载出现问题,这时文字说明就会显示,至少可以提供一点图片信息。
细心的你可能会发现,图片链接如果是网络的还好办,如果是本地图片,把文档导入网络平台(比如CSDN)时,图片就无法正常显示了,要重新上传图片导入并生成链接。这一问题的解决办法就是把图片放到网络服务器中存储,这样就把本地图片“变成”网络图片,我们可以引用网络链接查看图片,这就是图床的原理。但是很抱歉,我现在还没有用图床,等我用了之后,再写篇文章与大家分享。
3.8 排版规范
最后,我想补充一点,在 Markdown 写作时,了解一点排版规范对我们是有帮助的,这样显示的文章整洁美观,读者看着也舒服。向大家推荐我读到的一篇介绍排版规范的好文:会用 Markdown 还不够,还得知道排版规范。
4. 在哪用Markdown?
要写 Markdown 文档,一款得心应手的编辑器必不可少。我根据网友们的介绍和推荐,体验了几款受好评的编辑器,下面逐一介绍,看看您喜欢哪一款?
4.1 即写即显示:Typora
点击Typora官网,可以下载 Typora。
Typora 的最大特点就是即写即显示,有点像打字机 ( Typewriter ) 的效果,这样看来,这个名字很贴切。请看一下 Typora使用展示-27秒小视频,会对这种编辑体验有更多了解。
Typora 的页面干净整齐,插入图片、公式等十分便捷,因此受到众多 Markdown 写作者们的喜爱。
1.一键插入图片
使用 Typora 可以轻松插入图片,如果是屏幕截图,使用 Ctrl
+Alt
+V
键粘贴到文档;如果是本地图片,可以从存放文件夹中把图片拖动到文档中的编辑位置。然后,剩下的事就不用管了,Typora 会帮我们全部做好,包括将图片自动复制到 当前文档名.assets文件夹(如果没有会自动新建一个),Markdown 文档里也会生成图片链接,是不是很贴心?
2.文档转换
如下图所示,点击菜单栏 File > Export,然后选择你想要的文件类型,即可以实现转换。
但是,我现在没有经常使用 Typora,主要是还不适应即写即显示、不能对照看原始编辑的设置。如果有和我一样习惯的小伙伴,可以看看接下来的两款编辑器。
4.2 对照显示:Atom, VSCode
这两款编辑器大同小异,都是可以预览、对照显示的。Atom 由 Github 出品,可以从Atom官网下载。 VSCode, 全称为 Visual Studio Code,由微软出品,可以从VSCode官网下载。
有一点请注意,要使这两款编辑器发挥最佳性能,需要安装插件(Packages/ Extensions),下面以我现在使用的 VSCode 为例进行说明。
1.安装扩展(Extensions)
点击菜单栏 File > Preferences > Extensions,如图中所示:
然后在搜索栏中搜索扩展并安装:Markdown All in One
,Markdown Preview Enhanced
,Paste Image
。下图中我给出了一个示例,在搜索栏输入" markdown preview enhanced ",在未安装的扩展名右下角会有一个显示为install
的绿色按钮,点击即可安装。这里因为我已经安装了该扩展,所以没有显示,而在我尚未安装的扩展下方就显示了install
按钮。
2.扩展设置
此外,Paste Image 扩展在安装后还要进行设置。点击 File > Preferences > Settings,在搜索栏中输入:" Paste Image ",在结果中找到:
Name Prefix 一栏,填入${currentFileNameWithoutExt}
;
Path 一栏,填入${currentFileDir}/imgs
,具体如下图所示。
3.预览视图与文章目录
重新打开文档,可以看到右上方会出现预览按钮,点击下图中箭头指示的第一个按钮,即可出现 Preview 预览窗格。
在预览视图中,点击下图中箭头指示的第一个按钮,可以显示文章的目录。图中右侧显示的就是本文的目录。目录显示即为文章的大纲,对于我们阅读时理清文章脉络、写作时构建文章框架很有帮助。
还有一种显示文章目录的方法,就是在文章开头处加上[TOC]
,显示效果与上图的目录视图类似,本文开头的目录就是这样生成的,你也不妨试一试,看看效果如何。
4.快速贴图
因为安装了 Paste Image 扩展,截图贴图十分方便。以我自己使用的 Windows 系统为例,截图可以直接用 Windows
+Shift
+S
键,或者打开微信后用 Alt
+A
键,然后打开要插入图片的文档,使用 Ctrl
+Alt
+V
键,截图就会自动复制到 Markdown 文档目录下的 imgs 文件夹中,同时在文档中自动生成了图片链接。
但是与Typora 相比,VSCode还有一点不足:不能拖动本地图片到文档实现自动插入图片,也可能是我还没有安装所需的扩展,有知道的小伙伴请告诉我哦,谢谢!
5.文档转换
在预览视图中,点击鼠标右键,将出现下图所示的菜单栏,此时可以选择需要的文件类型进行转换。
4.3 多平台协作:印象笔记
有时我们可能在这个电脑上写了一点文字,然后又换个地方、换了电脑,难道还要把文档传过去才能编辑?
当然不用那么麻烦,可以使用多平台工具:印象笔记。印象笔记现在融合了马克飞象的功能,可以编辑 Markdown 文章了。这样要收集灵感、创意进行写作,就更加方便了。我这篇文章的初稿就是在印象笔记上写的。
如下图所示,打开印象笔记后,在新建笔记右方有个窗格图标(图中箭头指示位置),点击后有多种文档格式,选择 " Markdown ",即可新建一个 Markdown文档。
打开文档后,在右上方有一个编辑/预览切换按钮,如下图中箭头标示位置,点击之后文档可以在对照编辑模式(类似VSCode的显示模式)和预览模式 (类似Typora的显示模式,但是不能编辑) 之间切换,这样,如果只看文档显示效果,就可以点击这个按钮,切换到预览模式。
有一点请注意,印象笔记电脑端可以编辑写作 Markdown 文档,在手机端只能看 Markdown 文档的预览效果、不能对其编辑修改。
5. 我的 Markdown 使用经历和体会
看这篇文章的很多人可能都是打算用 Markdown 编辑器,或者刚开始用、犹豫要不要深入学一下 Markdown。因此,我说说自己是如何开始学习使用 Markdown,给大家提供参考。
一开始我在网上看到推荐和介绍 Markdown 编辑器,但是在实际中我也没有使用需求,所以迟迟未学。
后来在 Github 学习、看开源项目,其中的 Readme 文档都是用 Markdown 格式写的。还记得我刚下载一个项目,看到 Markdown 原始编辑文档,里面都是各种标记符号,头好大……但是,学会使用预览之后,显示效果就不一样了,简洁明了、重点突出。后来我练手做小项目,也模仿这些文档的格式,按 Markdown 语法写 Readme 文档,就这样开始了 Markdown 使用之路。
同时,我在编程学习中有了一些笔记和心得,想写出来与大家交流分享,这时就更加发觉Markdown 编辑器的重要了。在 Markdown 文档中插入代码、公式、链接、图片等十分方便,而且标题、加粗等可以边写边设置,编辑出来的文章版式也简单清晰。由此,我也扩展到其它文章的写作中,比如读书书评、英文有声书推荐等。
另外,我发现还可以将 Markdown 文档转换为微信公众号文章格式,分享一下我使用的在线转换器:微信公众号格式化编辑器,如果您发现了好的在线文档转换工具,别忘了分享一下哦,谢谢!
在使用过程中,我觉得 Markdown 是一个只要初期花费少量时间掌握简单的语法,后续就可以节省大量时间的编辑工具,最重要的是开始用,从编辑第一个简单的 Markdown 文档开始。
如果您觉得文章不错,请点赞支持一下,谢谢!
John Gruber的博客页面:https://daringfireball.net/projects/markdown/ ↩︎