跳到主要内容

Markdown 教程

- · -

什么是 Markdown?

Markdown 是一种轻量级标记语言,创始人为约翰·格鲁伯。它允许人们使用易读易写的纯文本格式编写文档,然后转换成有效的 XHTML(或者 HTML)文档。这种语言吸收了很多在电子邮件中已有的纯文本标记的特性。1

由于 Markdown 的轻量化、易读易写特性,并且对于图片,图表、数学式都有支援,目前许多网站都广泛使用 Markdown 来撰写说明文件或是用于论坛上发表讯息。如何方的个人小站GitHubRedditStack ExchangeOpenStreetMapSourceForge简书等,甚至还能被用来撰写电子书。

何方的个人小站除了首页工具,大都是用 Markdown 完成的

Markdown 如今已成为世界上最受欢迎的标记语言之一。2

  1. 专注于文字内容;
  2. 纯文本,易读易写,可以方便地纳入版本控制;
  3. 语法简单,没有什么学习成本,能轻松在码字的同时做出美观大方的排版。

Markdown 与 World 不同,Markdown 不像 World 是所见是所得的。如果需要把一段文本加粗,在 World 中,点击工具栏的加粗图标,内容就会被加粗。而在 Markdown 中我们可以使用在文本前后添加两个星号(**粗体**粗体)来达到同样的目的。

和 World 需要使用 Microsoft Office、WPS 等工具不同,Markdown 可以使用任何在线或本机的文本编辑器。比如下图是何方的个人小站的在线 Markdown 编辑器,我们后面的内容都以它做为演示工具。

在线Markdown工具在线Markdown工具
图1
在线Markdown工具

为什么要用 Markdown?2

当你可以通过按下界面中的按钮来设置文本格式时,为什么还要使用 Markdown 来书写呢?使用 Markdown 而不是 word 类编辑器的原因有:

  1. Markdown 无处不在。StackOverflow、CSDN、掘金、简书、GitBook、有道云笔记、V2EX、光谷社区等。主流的代码托管平台,如 GitHub、GitLab、BitBucket、Coding、Gitee 等等,都支持 Markdown 语法,很多开源项目的 README、开发文档、帮助文档、Wiki 等都用 Markdown 写作。
  2. Markdown 是纯文本可移植的。几乎可以使用任何应用程序打开包含 Markdown 格式的文本文件。如果你不喜欢当前使用的 Markdown 应用程序了,则可以将 Markdown 文件导入另一个 Markdown 应用程序中。这与 Microsoft Word 等文字处理应用程序形成了鲜明的对比,Microsoft Word 将你的内容锁定在专有文件格式中。
  3. Markdown 是独立于平台的。你可以在运行任何操作系统的任何设备上使用任何文本工具创建 Markdown 格式的文本。
  4. Markdown 能适应未来的变化。即使你正在使用的应用程序将来会在某个时候不能使用了,你仍然可以使用文本编辑器读取 Markdown 格式的文本。当涉及需要无限期保存的书籍、大学论文和其他里程碑式的文件时,这是一个重要的考虑因素。

用什么写 Markdwon?

上面我们说可以在运行任何操作系统的任何设备上使用任何文本工具创建 Markdown 格式的文本,我们确实可以使用任何文本工具创建 Markdown 文件,如果你想用 echo "内容" >> file.md 都可以。但使用一些具备代码高亮和实时预览功能的编辑器,可以让我们更加优雅和快速的编写 Markdown。

用 Markdown 最多的应该是程序员了(哪个程序员还没有写过文档🐶),一般程序员用的 IDE,诸如 VS Code、IDEA、Android Studio 等都内置了 Markdown 高亮和预览功能,下面是一些好用的 Markdown 工具。

  1. 编程/文本工具
    1. Visual Studio Code
    2. IntelliJ IDEA(包括 Android Studio、WebStorm 等)
    3. Sublime Text
    4. Nodepad++
    5. Atom
  2. 在线编辑器
    1. 何方的个人小站
    2. Markdown 中文网站
    3. Editor.md
    4. 小书匠
    5. 菜鸟工具
    6. MaHua
  3. 其他软件
    1. MarkdownPad
    2. BookPad
    3. 小书匠
    4. Typora

参考文档

该内容基于参考文档原创,转载请注明本页地址
https://iamhefang.cn/tutorials/markdown/