Markdown基础语法

最新推荐文章于 2022-07-18 18:45:24 发布
最新推荐文章于 2022-07-18 18:45:24 发布
阅读量273 收藏
点赞数
分类专栏： md
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_43884073/article/details/115406429
版权

文章目录

本文主要介绍 Markdown 的基础语法

总览

几乎所有的 Markdown 引擎都支持 Markdown 发明者 John Gruber 所设计的基本语法，但不同的 Markdown 处理引擎在细节表现方面略有不同，下面逐一介绍。

标题

要创建标题的话只需使用井号 # 开头，井号的数量对应标题的级别。比如如果你想要创建一个 <h3> 则可以通过用三个 # 开头：### 三级标题。使用井号的标题语法在 CommonMark 规范中称之为“ATX 标题”。

MarkdownHTML渲染结果
# 一级标题<h1>一级标题</h1>

一级标题

## 二级标题<h2>二级标题</h2>

二级标题

### 三级标题<h3>三级标题</h3>

三级标题

#### 四级标题<h4>四级标题</h4>
四级标题
###### 五级标题<h5>五级标题</h5>
五级标题
####### 六级标题<h6>六级标题</h6>
六级标题

标题可选语法

除了使用 ATX 标题外，我们还可以用 Setext 标题：在文本下一行用一个或多个等号 = 表示一级标题，一个或多个短横线 - 表示二级标题。

MarkdownHTML渲染结果
一级标题
======		<h1>一级标题</h1>

一级标题

二级标题
------------		<h2>二级标题</h2>

二级标题

标题最佳实践

  1. 段落之间的 ATX 标题最好使用空行分隔。因为有的 Markdown 引擎不识别缺少前后空行的标题语法。

    ✅ 稳妥❌ 不稳妥
    这是一个段落。

    # 一级标题

    另一个段落。    		这是一个段落。
    # 一级标题
    另一个段落

  2. ATX 标题的井号后务必加上一个空格

    ✅ 稳妥❌ 不稳妥
    # 一级标题# 一级标题

  3. 尽量不要使用 Setext 语法来写标题，因为 Setext 语法只能写到二级标题

段落

使用空行分隔文本即可。

MarkdownHTML渲染结果
我很喜欢使用 Markdown。

我将使用 Markdown 来排版我所有的文档。		<p>我很喜欢使用 Markdown。
<p>我将使用 Markdown 来排版我所有的文档。</p>

我很喜欢使用 Markdown。

我将使用 Markdown 来排版我所有的文档。

段落最佳实践

  1. 段落开头不要使用空格或者制表符（\t 即 Tab 键）来缩进，否则可能会被当做代码块渲染。

    ✅ 稳妥❌ 不稳妥
    开头不要缩进。

    像这样保持左对齐就好。    		开头缩进可能会被渲染为代码块。

  2. 中文传统排版上段落开头有着“空两格”的习惯，可以使用全角空格 或者 HTML 实体 &emsp;。科技领域的文章排版建议不要空两格，段落居左对齐较好

折行

如果需要文本折行 <br>，可在文本结尾加上两个或更多的空格然后回车。

MarkdownHTML渲染结果
这是第一行。
这是第二行。		<p>这是第一行。<br>这是第二行。</p>这是第一行。
这是第二行。

折行最佳实践

目前大部分 Markdown 引擎会自动将换行符 \n 转换为 <br>，即软换行转硬换行。所以结尾用两个或更多空格的写法虽然稳妥，但是可能也会造成一些小问题：结尾空格在一些编辑器中并不可视；不小心按到或者习惯性按到会造成错误排版。介于这些小问题，可能用 <br> 来折行是最稳妥的做法，但这又不太优雅。另外，在 CommonMark 规范中可以在文本结尾使用反斜杠 \ 来折行，但我也不太推荐这种写法。

综上，我的建议是不要使用结尾空格、\ 或者 <br>，因为现在几乎所有的 Markdown 引擎基本都已经支持软换行转硬换行了。

加粗和强调

加粗对应粗体，强调对应斜体。

加粗

要加粗文本，可以使用两个星号 ** 或者两个下划线 __ 包裹待加粗的文本。

MarkdownHTML渲染结果
把文本**加粗**一下把文本<strong>加粗</strong>一下把文本加粗一下
把文本__加粗__ 一下把文本 <strong>加粗</strong> 一下把文本加粗 一下
加粗最佳实践

加粗用星号和用下划线的不同之处在于星号用法前后可以不加空格，但下划线必须要加。

✅ 稳妥❌ 不稳妥
星号**加粗**无需空格没有空格下划线__加粗__无效

强调

要强调文本，可以使用一个星号 * 或者一个下划线 _ 包裹待强调的文本。

MarkdownHTML渲染结果
把文本*强调*一下把文本<em>强调</em>一下把文本强调一下
把文本_强调_ 一下把文本 <em>强调</em> 一下把文本强调 一下
强调最佳实践

和加粗类似，星号用法前后可以不加空格，但下划线必须要加。

✅ 稳妥❌ 不稳妥
星号*强调*无需空格没有空格下划线_强调_无效

加粗并强调

如果你需要加粗的同时强调文本，可以使用三个星号 *** 或者三个下划线 ___ 包裹待强调的文本。

MarkdownHTML渲染结果
同时***加粗并强调*** 的示例同时 <strong><em>加粗并强调</em></strong> 的示例同时加粗并强调 的示例
同时___加粗并强调___ 的示例同时 <strong><em>加粗并强调</em></strong> 的示例同时加粗并强调 的示例
同时__加粗并强调__ 的示例同时 <strong><em>加粗并强调</em></strong> 的示例同时加粗并强调 的示例
同时**加粗并强调** 的示例同时 <strong><em>加粗并强调</em></strong> 的示例同时加粗并强调 的示例
星号***可以不用***加空格星号<strong><em>可以不用</em></strong>加空格星号可以不用加空格

块引用

要创建块引用 <blockquote> 的话仅需在段落前加上大于号 >。

> 原谅我这一生不羁放纵爱自由，也会怕有一天会跌倒
> 背弃了理想 ，谁人都可以
> 哪会怕有一天只你共我

渲染结果

原谅我这一生不羁放纵爱自由，也会怕有一天会跌倒
背弃了理想 ，谁人都可以
哪会怕有一天只你共我

块引用内分段

如果需要分段的话需要可以在分段空行前加上一个 >。

> 今天我， 寒夜里看雪飘过
> 怀着冷却了的心窝漂远方
>
> 风雨里追赶， 雾里分不清影踪
> 天空海阔你与我

渲染结果：

今天我， 寒夜里看雪飘过
怀着冷却了的心窝漂远方

风雨里追赶， 雾里分不清影踪
天空海阔你与我

嵌套块引用

块引用可以嵌套使用，在段落前添加两个大于号 >> 表示两层嵌套。

> 块引用段落
>
>> 嵌套的块引用段落

块引用包含其他元素

块引用能够包含其他大部分语法元素。CommonMark 规范将块引用定义为容器块，容器块可以包含任意块级元素和行级元素，也就是说块引用可以包含其他任意元素。

> ### 标题是叶子块元素
>
> * 列表项一是容器块元素
> * 列表项二也是容器块元素
>
> **加粗**和*强调*是行级元素。

渲染结果：

标题是叶子块元素

  • 列表项一是容器块元素
  • 列表项二也是容器块元素

加粗和强调是行级元素。

列表

列表分为有序列表和无序列表。Markdown 中的列表只能包含列表项元素，列表项和块引用一样，都是容器块。也就是说列表项可以包含其他任意元素。

有序列表

有序列表可以通过阿拉伯数字后跟 . 或者 ) 来创建，数字不必递增连续。

MarkdownHTML
1. 列表项一
2. 列表项二
<ol><li>列表项一</li><li>列表项二</li></ol>
1. 列表项一
1. 列表项二
<ol><li>列表项一</li><li>列表项二</li></ol>
1. 列表项一
3. 列表项二
<ol><li>列表项一</li><li>列表项二</li></ol>

无序列表

无序列表可以通过短横线 -、星号 * 或者加号 + 来开头，后面需要跟一个空格来分隔文本内容。

MarkdownHTML
- 列表项一
- 列表项二
<ul><li>列表项一</li><li>列表项二</li></ul>
* 列表项一
* 列表项二
<ul><li>列表项一</li><li>列表项二</li></ul>
+ 列表项一
+ 列表项二
<ul><li>列表项一</li><li>列表项二</li></ul>

列表项包含其他元素

列表项可以包含其他任意元素，比如段落、块引用、代码块、图片等。使用要点是待包含元素的起始字符要和列表项起始内容“对齐”。

列表项包含段落
* 列表项一
* 列表项二第一段
  
  这是第二段
* 列表项三

渲染结果：

  • 列表项一
  • 列表项二第一段
    这是第二段
  • 列表项三
列表项包含块引用
* 列表项一
* 列表项二第一段
  
  > 第二段是块引用
* 列表项三

渲染结果：

  • 列表项一

  • 列表项二第一段

    第二段是块引用

  • 列表项三

列表项包含代码块
* 列表项一
* 列表项二第一段
  
```

  这里是代码块
  echo 你好，世界！

   ```
* 列表项三

渲染结果：

  • 列表项一

  • 列表项二第一段

    这里是代码块
echo 你好，世界！

  • 列表项三

列表项包含图片
* 列表项一
* 列表项二第一段
  
  ![B3log](https://static.b3log.org/images/brand/b3log-128.png "B3log 开源社区")
* 列表项三

渲染结果：

  • 列表项一
  • 列表项二第一段
    [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-N2CtVilh-1617362068833)(https://static.b3log.org/images/brand/b3log-128.png)]
  • 列表项三

代码

代码可以通过反引号 span 包裹。

MarkdownHTML渲染结果
列出文件命令是`ls`列出文件命令是 <code>ls</code>列出文件命令是 span

转义反引号

如果你需要显示反引号，可以用转义符 \ 来对反引号进行转义。

MarkdownHTML渲染结果
打个反引号`span打个反引号 `

代码块

代码块可以使用四个空格缩进或者制表符 \t 缩进。

    <html>
      <head>
      </head>
    </html>

渲染结果：

<html>
  <head>
  </head>
</html>

推荐使用围栏代码块语法来排版代码块，即使用 span 来包裹代码块，并且指定语法高亮语言：

​```html
<html>
  <head>
  </head>
</html>
```

分隔线

通过大于等于三个星号 ***、短横线 --- 或者下划线 ___ 来创建分隔线。

​```markdown


渲染结果：

---

## 超链接

通过 `[链接文本](URL)` 来创建超链接。

```markdown
我们来自小众开源社区 [B3log](https://b3log.org)。

渲染结果：

我们来自小众开源社区 B3log。

添加超链接标题

链接标题是可选的，在圆括号中的 URL 后用双引号包裹。鼠标移到超链接上会浮出显示标题内容。

我们来自小众开源社区 [B3log](https://b3log.org "B3log 开源")。

渲染结果：

我们来自小众开源社区 B3log。

URL 和邮件地址

如果要直接显示 URL 或者邮件地址，可以通过 < 和 > 来包裹 URL 或者邮件地址。

<https://b3log.org>

<os@b3log.org>

大部分 Markdown 引擎也支持自动转换，这样可以省去 <>：

https://b3log.org

os@b3log.org

超链接格式排版

超链接可以和加粗强调、代码等元素结构一同使用。

我们来自小众开源社区 **[B3log](https://b3log.org)**。
我们来自小众开源社区 [`B3log`](https://b3log.org)。

渲染结果：

我们来自小众开源社区 B3log。
我们来自小众开源社区 B3log。

引用风格的超链接

使用引用风格的超链接可以让 Markdown 原文更容易阅读。引用风格的超链接分为两部分：链接引用和链接定义。

链接引用

链接引用用于在需要插入超链接的地方，它由两组方括号构成，第一组方括号用于指定链接文本，第二组方括号用于指定链接标识，链接标识指向链接定义。

[链接文本][链接标识]

[链接标识]: https://b3log.org

渲染结果：

链接文本

链接引用也可以只由一组方括号构成，这种情况下链接标识将用于链接文本。

[链接标识]

[链接标识]: https://b3log.org

渲染结果：

链接标识

链接定义

链接定义由三部分构成：

  1. 方括号包裹定义链接标识，后跟冒号 :
  2. URL，可以直接写也可以用尖括号 <> 包裹
  3. 链接标题，这部分是可选的，可以用双引号、单引号或者圆括号包裹
[链接标识]: https://b3log.org
[链接标识]: <https://b3log.org>
[链接标识]: https://b3log.org "B3log 开源"
[链接标识]: https://b3log.org 'B3log 开源'
[链接标识]: https://b3log.org (B3log 开源)

链接定义可以放在整个 Markdown 文本的任何位置。有的人习惯将其放于引用所在段落之后，有的人习惯将其放于文末位置。

超链接最佳实践

英文内容天然使用空格分隔，所以在使用自动超链接时不存在分隔问题。但中文会存在该问题，比如：

我们的网址是https://b3log.org欢迎开源爱好者加入！

这段内容在很多 Markdown 引擎上会渲染不正确。为了尽量保证兼容性，可以考虑使用空格进行分隔：

我们的网址是 https://b3log.org 欢迎开源爱好者加入！

或者使用尖括号 <> 包裹：

我们的网址是<https://b3log.org>欢迎开源爱好者加入！

这样就能得到预期的渲染结果了：

我们的网址是 https://b3log.org 欢迎开源爱好者加入！

图片

使用感叹号 ! 后跟超链接就可以渲染图片了。

![B3log Logo](https://files.mdnice.com/dance.gif)

渲染结果：

B3log Logo

超链接嵌套图片

如果你需要图片点击可以跳转超链接，只需要在链接文本部分包含图片即可。

[![链滴](https://static.b3log.org/images/brand/hacpai-128.png)](https://ld246.com)

渲染结果：

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-Rq8hTuCf-1617362068837)(https://static.b3log.org/images/brand/hacpai-128.png)]

转义字符

可使用反斜杠 \ 来转义如下字符：

字符中文名称
\反斜杠
span反引号
*星号
_下划线
{}花括号
[]方括号
()圆括号
#井号
+加号
-短横线（减号）
.点
!感叹号
span竖线（管道符号）

几乎所有 ASCII 标点符号都可以使用反斜杠进行转义。

嵌入 HTML

Markdown 天然支持嵌入 HTML 代码。

**Markdown** 和 <em>HTML</em> 混合排版。

渲染结果：

Markdown 和 HTML 混合排版。

嵌入 HTML 最佳实践

这在需要设置图片大小、字体颜色时会比较有用，但我们并不建议过多使用 HTML 来进行排版，一来是因为这样做实际上并不通用，因为有的 Markdown 引擎因为安全原因会过滤部分标签或者属性；二来是因为这样做太不 Markdown 了！

另外，请勿在 HTML 中嵌入 Markdown，这样并不工作：

<p>**粗体**不会生效。</p>

渲染结果：

**粗体**不会生效。

总结

使用好空行和空格是 Markdown 排版的关键，很多时候就是因为少了个空行或者空格导致产生了非预期的渲染结果。

随着 CommonMark/GFM 规范日趋完善并逐渐成为业界统一的 Markdown 标准，已经有越来越多的 Markdown 引擎实现了该规范。建议 Markdown 使用者尽量该遵循规范来进行排版，这样才能最大程度地避免细节渲染问题。

参考

[已收录Dc-Notes](

DreamCaters
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Markdown语法入门
车子（chezi）
02-21 978
版本 时间 修订内容 1.0 2018-4-5 完善了“表格”这一节 写在前面： 若没有特别说明，则以CSDN在线编辑器为例，不同的编辑器或平台也许效果不一样。 关于Markdown语法的文章是汗牛充栋，一搜一大片。这里我不打算写一篇大而全的文章，而是提纲挈领，让新手快速入门。 Markdown 是什么 Markdown 是一种轻...
Markdown 基础入门
yexiangCSDN的专栏
05-13 368
认识 Markdown Markdown 是一种用来写作的轻量级「标记语言」，它用简洁的语法代替排版，而不像一般我们用的字处理软件 Word 或 Pages 有大量的排版、字体设置。它使我们专心于码字，用「标记」语法，来代替常见的排版格式。Markdown 文档从内容到格式，甚至插图，通过键盘就可以通通搞定。现在，支持 Markdown 语法的编辑器有很多，包括很多网站（例如 CSDN 博客、CODE CHINA）都支持了 Markdown 格式。Markdown 从写作到完成，导出格式随心所欲，你可以导
关于Markdown使用方法及细则
QINGXIJUANJUAN的博客
03-01 813
文章内容为 Markdown官网的教程及博主自己对其的理解
markdown的基本使用方法
qq_39340141的博客
12-24 4764
1.用前准备工作 ​ 下载markdown工具,可以在网上自行搜索。markdown就是一种语言格式而已，既然选择学习markdown肯定见过markdown写的东西了。这里就不多说了，会用就行。 2.标题 # 标题 ​ #、##、… ​ # 的个数从h1 - h6，#号越多那么字体就越小了，这里要注意的一点就是使用的时候#后面要记着加空格。 3. 文字加粗或者斜体和文字颜色 斜体1 ​ *斜体 文本* 斜体2 ​ _斜体的文本_ 粗体1 ​ **粗体文本** 粗体2 ​ __粗体文本__
Markdown学习笔记（三）
m0_62014344的博客
07-18 897
Markdown 使用教程介绍（入门）
markdown-markdown基础语法讲解.zip
01-17
下面将详细介绍Markdown的基础语法。 ### 一、标题 Markdown支持两种标题格式： 1. 使用`#`号来创建标题，#的数量决定标题的级别，最多六级。例如： ``` # 一级标题 ## 二级标题 ### 三级标题 ... ``` 2. ...
Markdown 基础语法
09-21
Markdown基础语法，9月21日，自我记录 标题 - 在文字前加1到6个# 然后空格 语法2： 代码引用 - 将代码对应文字放在3个反引号开头和结尾之间：``` 语法4：图片 - `` ![ ](图片地址)``![ ](E:\...
markdown基础语法总结
01-20
Markdown的基本语法主要包括以下几个方面： 1. **标题**：Markdown提供两种创建标题的方式。一是使用等号（=）和减号（-）来表示一级和二级标题，例如： ``` 我是一级标题 ------------- 我是二级标题 -------...
Markdown基础语法1
08-03
Markdown的基础语法简单直观，使得非专业程序员也能轻松掌握。以下是一些Markdown的基本元素和使用方法： 1. **换行**：在一行文字后直接输入两个空格或按回车键两次，即可实现新行。 2. **文本样式**： - **斜体...
自己总结的一些Markdown基础语法
最新发布
06-18
Markdown 是一种轻量级标记语言，是一种书写的格式，能将文本换成有效的XHTML(或者HTML)文档、PDF、WORD等，语法简洁明了，易于掌握，所以用它来写作是件既效率又舒服的事情。 Markdown 的理念是，能让文档更容易读...
MarkDown基础语法使用.pdf
04-23
### MarkDown基础语法详解 #### 一、标题 在MarkDown中定义标题非常简单，只需在文本前加上对应数量的`#`号即可。`#`号的数量代表着标题的级别，从一级到六级不等。 - **一级标题**：使用1个`#`号，如：`# 一级...
Typora-Markdown基础语法学习.md
09-04
关于Markdown常用语法的简单介绍
markdown基础语法.md
08-23
markdown语法简介
MarkDown基础语法使用.md
04-16
个人学习，不建议下载
MyMarkdown:Markdown 基础语法。可以应付开发过程中各类文档， 告别Word ，txt！！！
05-17
Markdown 基础语法 执行概要 内容： Markdown 是什么？ Markdown 是谁创造的？ 为什么要使用Markdown? Markdown怎么使用？ Markdown 都有哪些人在用？ 尝试一下Markdown的使用！ Markdown 进阶语法！ 学习目标 通过...
makedown标题的两种语法
我的梦境传说
03-08 344
Markdown支持两种标题的语法: Setext 和 Atx 格式 1. Setext 语法格式如下: 使用 = (最高阶标题) 和 - (第二阶标题) , 例如: 这是一阶标题 ============ 这是二阶标题 ------ 效果如下: 这是一阶标题 这是二阶标题 需要强调的一点是:任意数量的 = 和 - 都有效果 2. Atx 语法格式如下: 使用 # 来表示标题,例如: ...
markdown：表格内如何换行？<br>
热门推荐
kakazai.cn
01-19 1万+
用HTML代码中的&lt;br&gt; 如下所示，要在“身高”换行后加“体重”，可以在本行末尾输入&lt;br&gt;，再输入“体重”，则马上换行显示。 源码： | 姓名 | 特征 | | ---- | ----------- | | 小王 | 身高：175cm | | 姓名 | 特征 | | ---- | -----------------...
markdown表格内换行
丰哥的专栏
06-10 3170
markdown表格内换行 使用html标记语言<br>。
Markdown 语法说明
panshiqu的专栏
09-27 762
内容整理自 Markdown 语法说明 (简体中文版) ，便于自己快速复习，若想系统学习 Markdown 请访问原网页。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值