一、什么是Markdown?¶
Markdown是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档,将格式元素添加到纯文本文档。Markdown允许您使用易于阅读、易于编写的纯文本格式进行编写,然后将其转换为结构上有效的XHTML(或HTML)。Markdown是由约翰·格鲁伯(John Gruber)于2004年创建,现在是世界上最受欢迎的标记语言之一。
二、为什么要用Markdown?¶
Markdown编写的文档可以导出HTML、Word、图像、PDF、Epub等多种格式的文档。
Markdown编写的文档后缀为 .md、.markdown。
你可以使用文本编辑器应用程序将Markdown格式元素添加到纯文本文件中。或者,您可以使用macOS、Windows、Linux、iOS和安卓操作系统的众多Markdown应用程序之一。还有一些基于web的应用程序专门设计用于以Markdown方式编写。
Markdown是可移植的。包含Markdown格式文本的文件几乎可以使用任何应用程序打开。如果您决定不喜欢当前使用的Markdown应用程序,可以将Markdown文件导入另一个Markdown应用程序。这与Microsoft word等文字处理应用程序形成了鲜明对比,后者将您的内容锁定为专有文件格式。
Markdown与平台无关。您可以在运行任何操作系统的任何设备上创建Markdown格式的文本。
Markdown无处不在。Reddit和GitHub等网站支持Markdown,许多桌面和基于web的应用程序都支持Markdown。
Markdown可以用于任何事情,通过简单的标记语法,它可以使普通文本内容具有一定的格式。
-
整理知识,学习笔记
-
发布日记,杂文,所见所想
-
撰写发布技术文稿(代码支持)
-
撰写发布学术论文(LaTeX 公式支持)
-
使用它创建网站、文档、书籍、演示、电子邮件和技术文档
-
Markdown 能被使用来撰写电子书,如:Gitbook。
三、支持Markdown的应用程序和组件,工具¶
当前许多网站都广泛使用Markdown来撰写帮助文档或是用于论坛上发表消息。例如:GitHub、Gitee、GitLab、简书、掘金、reddit、Diaspora、Stack Exchange、OpenStreetMap、SourceForge等。
支持Markdown的工具有很多,链接地址:https://www.markdownguide.org/tools/
![[Pasted image 20260127190857.png]]
四、Markdown文件的工作原理¶
以网页版Markdown工具Dillinger为例:
![[Pasted image 20260127191037.png]] 总之,这是一个由四部分组成的过程:
-
使用文本编辑器或专用的Markdown应用程序创建Markdown文件。文件应具有.md或.Markdown扩展
-
在Markdown应用程序中打开Markdown文件
-
使用Markdown应用程序将Markdown文件转换为HTML文档
-
在web浏览器中查看HTML文件,或使用Markdown应用程序将其转换为其他文件格式,如PDF
五、Markdown的基本语法¶
几乎所有Markdown应用程序都支持原始Markdown设计文档中概述的基本语法
Markdown处理器之间存在微小的差异和差异。
1.标题¶
要创建标题,请在单词或短语前添加数字符号(#),您使用的数字符号的数量应与标题级别相对应。
| Markdown | HTML | 渲染输出 |
|---|---|---|
| # Heading level 1 | <h1>Heading level 1</h1> |
Heading level 1 |
| ## Heading level 2 | <h2>Heading level 2</h2> |
Heading level 2 |
| ### Heading level 3 | <h3>Heading level 3</h3> |
Heading level 3 |
| #### Heading level 4 | <h4>Heading level 4</h4> |
Heading level 4 |
| ##### Heading level 5 | <h5>Heading level 5</h5> |
Heading level 5 |
| ###### Heading level 6 | <h6>Heading level 6</h6> |
Heading level 6 |
2.段落¶
要创建段落,请使用空行分隔一行或多行文本。
| Markdown | HTML | 渲染输出 |
|---|---|---|
| I really like using Markdown. I think I'll use it to format all of my documents from now on. |
<p>I really like using Markdown.</p> <p>I think I'll use it to format all of my documents from now on.</p> |
我真的很喜欢使用Markdown。 我想从现在开始我会用它来格式化我的所有文档。 |
3.换行符¶
要创建换行符( < br>),请以两个或多个空格结束一行,然后键入 return。
| Markdown | HTML | 渲染输出 |
|---|---|---|
| This is the first line. And this is the second line. |
<p>This is the first line. <br> And this is the second line.</p> |
这是第一行。 这是第二行。 |
4.强调(加粗)¶
您可以通过将文本设置为粗体或斜体来增加重点。
要加粗文本,请在单词或短语前后添加两个星号或下划线。为了强调单词的中间部分,请在字母周围添加两个不带空格的星号。
| Markdown | HTML | 渲染输出 |
|---|---|---|
| I just love bold text. | I just love <strong>bold text</strong>. |
我只是喜欢粗体字。 |
| I just love bold text. | I just love <strong>bold text</strong>. |
我只是喜欢粗体字。 |
| Loveisbold | Love<strong>is</strong>bold |
爱是勇敢的 |
5.斜体¶
要使文本变为斜体,请在单词或短语前后添加一个星号或下划线。
为了强调单词中间的斜体,请在字母周围添加一个不带空格的星号。
| Markdown | HTML | 渲染输出 |
|---|---|---|
| Italicized text is the cat’s meow. | Italicized text is the <em>cat’s meow</em>. |
斜体字是猫的叫声。 |
| Italicized text is the cat’s meow. | Italicized text is the <em>cat’s meow</em>. |
斜体字是猫的叫声。 |
| A _cat_meow | A <em>cat</em> meow |
一只猫喵 |
6.块引用¶
![[Pasted image 20260127201754.png]]
7.嵌套块引用¶
![[Pasted image 20260127201927.png]]
8.带有其他元素的引用块¶
TIP
引用块可以包含其他 Markdown 格式的元素,并非所有元素都可以使用,需要尝试看看哪些元素有效。
![[Pasted image 20260127202653.png]]
渲染的输出如下所示:
![[Pasted image 20260127202717.png]]
9.列表 - 有序列表¶
TIP
在每一行的前面加上一个数字和一个点号(.),然后跟一个空格
列表中的每个项目都应以递增的数字开始(尽管 Markdown 引擎会自动处理数字顺序,你仍然可以按任意顺序输入它们)
![[Pasted image 20260127203256.png]]
渲染的输出如下所示 ![[Pasted image 20260127203344.png]]