MarkDown语法汇总

2023-05-16

文章目录

  • 总览
  • 标题
    • 1. 使用#号创建标题
    • 2. 使用=和-号创建标题
  • 段落
    • 1. 换行
    • 2. 字体格式
    • 3. 删除线
    • 4. 脚注
    • 5. 下划线
    • 6. 首行缩进
    • 7. 字体颜色、大小、字体类型
    • 8. 文本高亮
  • 块引用
    • 1. 嵌套块引用
    • 2. 具有其他元素的块引用
  • 列表
    • 1. 有序列表
    • 2. 无序列表
  • 代码
    • 1. 代码块
    • 2. 围栏代码块
  • 链接
    • 1. 为链接添加标题
    • 2. 网址和电子邮件地址
    • 3. 格式化链接
  • 图片
  • 表格
    • 1. 使用图形界面创建表格
    • 2. 对齐方式
  • 转义字符
    • 1. 可以转义的字符
  • 参考

总览

Markdown是一种轻量级的标记语言,可用于将格式设置元素添加到纯文本文档中。Markdown 由John Gruber于2004年创建,如今已成为世界上最受欢迎的标记语言之一。

标题

1. 使用#号创建标题

使用 # 创建标题可以支持6级标题。你需要几级标题就输入几个 # 号,然后再输入一个空格后,即可生成所需要的标题。

# 1级标题
## 2级标题
### 3级标题
#### 4级标题
##### 5级标题
###### 6级标题

标题显示效果1

2. 使用=和-号创建标题

使用 = 可以创建一级标题,使用-可以创建二级标题。

一级标题
========
二级标题
--------

标题显示效果图2

段落

段落直接输入文字就行了,切记行首不要带有空格 Space 或制表符 Tab

1. 换行

输入两个或两个以上空格结束一行,然后键入回车键 Enter.

2. 字体格式

*斜体字 >>就是在字的前后各添加一个星号*  
_斜体字 >>也可以在字的前后各添加一个下划线_  
**粗体字 >>就是在字的前后各添加两个星号**  
__粗体字 >>也可以在字的前后各添加两个下划线__  
***粗斜体字 >>就是在字的前后各添加三个星号***  
___粗斜体字 >>也可以在字的前后各添加三个下划线___  

段落-字体格式显示效果图

3. 删除线

可以通过在段落的字体上放置一条横线来表示“删除”,表示这是错误的或不存在。要实现该功能只需要在文字的两端添加两个波浪线 ~~ 即可。

~~世界是平坦的。~~ 我们现在知道世界是圆的。

段落-删除线显示效果图

4. 脚注

脚注使您可以添加注释和参考,而不会使文档正文混乱。创建脚注时,带有脚注引用的链接将出现带有链接的上标编号。读者可以单击链接跳至页面底部的脚注内容。

这是测试脚注[^标识符]。

这是数字脚注[^1]。这是文字脚注[^文本脚注]

[^标识符]:标识符可以是数字或文本。但不能包含空格或制表符。  
[^1]:数字脚注测试说明。  
[^文本脚注]:文本脚注测试说明。

段落-脚注显示效果图

5. 下划线

Markdown本身并没有该语法,因为会和超链接样式混淆。所以如非不要请不要添加。
但可以使用html标签来实现(u指的是underline下划线)。

<u>需要添加下划线的内容</u>

段落-下划线显示效果图

6. 首行缩进

Markdown本身并没有该语法,但可以使用下面的语法(两个&emsp;)替代传统的两个字符缩进。

&emsp;&emsp;Markdown本身并没有该语法,这只是一种非常简单的替代方法;当然Markdown语法支持html语句,可以直接用html标签来实现,请自行搜索学习。

段落-首行缩进显示效果图

7. 字体颜色、大小、字体类型

Markdown本身并没有该语法,但Markdown支持HTML的语法。

<font color="" size=4 face="">字体颜色、大小、字体类型</font>  
<font color="blue" size=3 face="楷体">这是蓝色3号楷体子</font>  
<font color="red">这是红色字体,可单独配置一项</font>  
<font size=4>这是4号字体,可单独配置一项</font>  

8. 文本高亮

Markdown本身并没有该语法,但Markdown支持HTML的语法。

不需要高亮,<mark>重点提示需要高亮显示</mark>,\<mark> 是HTML5的新标签。

段落-高亮显示

块引用

在段落的开头添加一个 > , 然后再键入一个空格。

> 块引用  
> blockquote  

段落-块引用显示效果图

1. 嵌套块引用

区块可以嵌套,在需要的段落前面再添加一个 >

> 嵌套主体  
>> 第一层嵌套  
>>> 第二层嵌套 

块引用嵌套显示效果图

2. 具有其他元素的块引用

块引用可以包含其他Markdown格式的元素。并非所有元素都可以使用-您需要进行实验以查看哪些元素有效。

> ### 在块引用中添加标题 
> 1. 在块引用添加项目编号
> 2. 在块引用添加项目编号  
> + 在块引用添加项目符号 
> - 在块引用添加项目符号 
> * 在块引用添加项目符号 
> - **粗体文本** 和 *斜体文本*

块引用添加其他元素显示效果图

列表

支持有序列表和无序列表。

1. 有序列表

只需要在前面添加添加数字和. ,然后键入空格Space。数字不必按数字顺序排列,但列表应以数字开头。

1. 第一项
2. 第二项
3. 第三项
4. 第四项
5. 第五项
6. 第六项
   1. 缩进项(键入4个空格或制表符)
   2. 缩进项(键入4个空格或制表符) 

列表-有序显示效果图

2. 无序列表

请在订单项前添加减号 -,星号 * 或加号 +

- 第一项
- 第二项
* 第三项
* 第四项
+ 第五项
+ 第六项
    + 缩进项(键入4个空格或制表符)
    - 缩进项(键入4个空格或制表符) 

列表-无序列表显示效果图

代码

要将段落中的函数或其他表达式表示为代码,请将其括在勾号 ` 中。

`main()`函数中调用`printf()`函数

代码-显示效果图

1. 代码块

要创建代码块,请在代码块的每一行缩进至少四个空格 Space 或一个制表符 Tab

for(i=0; i<8; i++) {
    printf("这是代码块测试代码");
    delay_ms(1000);                 /* 延时1s */
}

代码-代码块显示效果图

2. 围栏代码块

根据Markdown处理器或编辑器的不同,您将在代码块之前和之后的行上使用三个刻度线 ``` 或三个波浪号~~~ ;如果需要高亮显示,请指定对应的语言,诸如C、C++、JAVA、Python等等。

```
for(i=0; i<8; i++) {
    printf("这是代码块测试代码");
    delay_ms(1000);                 /* 延时1s */
}
```
```c++
for(i=0; i<8; i++) {
    printf("这是代码块测试代码");
    delay_ms(1000);                 /* 延时1s */
}
```

代码-围栏代码块显示效果图

链接

创建链接时。首先再方括号中填写链接文本(例如[链接名称]),然后再紧跟方括号的括号(例如(https://www.baidu.com/))中填写链接地址URL。

我常用的搜索引擎是[百度](https://www.baidu.com/)

链接-显示效果图

1. 为链接添加标题

您可以选择为链接添加标题。当用户将鼠标悬停在链接上时,这将显示为工具提示。要添加标题,直接在URL后面键入空格 Space 后添加标题。

我常用的搜索引擎是[百度](https://www.baidu.com/ "众里寻他千百度")。

链接-添加标题显示效果图.gif

2. 网址和电子邮件地址

要将URL或电子邮件地址快速转换为链接,请将其括在尖括号中。

<https://markdown.p2hp.com>
<xxxx@email.com>

链接-网址和电子邮件地址显示效果图.gif

3. 格式化链接

为了强调链接,请在方括号和括号之前和之后添加星号。
其实就是相当于段落中字体格式的设置。

图片

要添加图像,请在链接的前面添加感叹号(!),然后在括号中添加替代文本,并在括号中添加图像资源的路径或URL。您可以选择在括号中的URL之后添加标题。

![链接-添加标题显示效果图.gif](https://gitee.com/cynalfly/mimage/raw/master/Image/MarkDown%E8%AF%AD%E6%B3%95%E6%B1%87%E6%80%BB/%E9%93%BE%E6%8E%A5-%E6%B7%BB%E5%8A%A0%E6%A0%87%E9%A2%98%E6%98%BE%E7%A4%BA%E6%95%88%E6%9E%9C%E5%9B%BE.gif)

链接-添加标题显示效果图.gif

表格

要添加表格,请使用三个或多个连字符 创建每列的标题,并使用竖线 | 分隔每列。

| 标题 | 标题 |
| --- | -------------- |
| 单元格 | 单元格 |
| 单元格 | 单元格 |

1. 使用图形界面创建表格

使用字符创建表格很费事、很麻烦,为了加快这一过程,我们可以使用在线表格生成器Markdown Tables Generator。

表格-图形界面创建表格

2. 对齐方式

要实现类似Excel文本的左对齐、居中、右对齐,只需要在连字符的左侧、两侧、右侧添加冒号 : 即可。

| 物料编号 | 物料名称 | 物料封装 |
| :--- | :------: |----:|
| 1 | PCB板 | Main Board |
| 2 | SPC5634MF2MLQ80 | LQFP144 |

表格-对齐方式显示效果图

转义字符

Markdown使用很多字符表示特定的意思,要显示原义字符,请在字符的前面添加反斜杠 \ ,这样就可以转义字符了。

#### 没有使用反斜杠,这是4级标题
\#### 使用反斜杠,这就是4个#号

转义字符-显示效果图

1. 可以转义的字符

字符 名称
\反斜杠
`刻度线
*星号
_下划线
{}大括号
[]中括号
()括号
#井号
+加号
-减号(连字符)
.
!感叹号
|竖线

参考

[1]. Markdown指南

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

MarkDown语法汇总 的相关文章

  • 无法在 GitHub 上呈现标头

    这是我的README md在 GitHub 存储库中 This is a Header This is not a Header 这两行都呈现为纯文本 第一个应该呈现为标题 我记得它之前是这样的 我不知道我的浏览器 macOS 上的 Chr
  • 如何在 Sublime Text Markdown 预览中启用 MathJax 渲染

    我正在使用 Sublime Text 3 编写一个包含数学的 Markdown 文档 Markdown Preview 包可以在浏览器 Chrome 中实时渲染文档 所以当我写这篇文章时 变化是显而易见的 以下是我的 Markdown 文本
  • 将多个帧选项传递到 rmarkdown::beamer_presentation 中的单个帧

    如何将多个框架选项传递给特定框架rmarkdown beamer presentation 在下面的 MWE 中 第二帧应包含与前一帧相同的表 只是多了几行 Thus 理想情况下 两个框架的页码相同 gt noframenumbering
  • 如何使用 Node.js 标记 Markdown?

    我正在构建一个 iOS 应用程序 该应用程序的视图将从 Markdown 中获取其来源 我的想法是能够将 MongoDB 中存储的 markdown 解析为 JSON 对象 如下所示 h1 This is the heading p Her
  • 如何在 Slidify 中使用 MathJax?

    似乎只需声明即可widget mathjax在扉页中 但我无法正确呈现公式 有什么遗漏的吗 谢谢 UPDATE 我查了一下最终结果index html 发现很多 都变成了 em or em 似乎 slideify 正在混合 在 LaTeX
  • Markdown 所见即所得编辑器和预览在同一文本区域中[关闭]

    Closed 此问题正在寻求书籍 工具 软件库等的推荐 不满足堆栈溢出指南 help closed questions 目前不接受答案 我寻找一个编辑器来编写 Markdown 语法并在同一文本区域中预览 例如引导所见即所得HTML5 ht
  • 关于:链接(Markdown 页面)上的blank#blocked

    在 Markdown 页面中 Microsoft TFS Wiki 我尝试创建 A 标签file link a href file txt a 点击 Chrome 后 我得到了 about blank blocked 这不是 Chrome
  • 使用express和marked返回渲染的markdown

    因此 我正在运行一个小型测试应用程序 以在访问路线时返回 html 中的 markdown 文件的内容 我正在使用标记来呈现降价 https github com chjj marked https github com chjj mark
  • 如何处理 Ipython Notebook 中的引用?

    在 Ipython Notebook 中处理引用的最佳方法是什么 理想情况下 我想要一个 bibtex 文件 然后像在 Latex 中一样 在 Ipython markdown 单元格中拥有一个速记列表 并在笔记本末尾提供完整的参考文献 我
  • 如何在knitr中安装软件包?

    到目前为止 我一直在使用这段代码来加载 R 包并编写 R 文件 但我正在尝试使用knitr rm list ls all TRUE kpacks lt c ggplot2 install github devtools mapdata ne
  • yard 0.7.3 无法在 Markdown 和 Textile 中构建我的自述文件

    我决定将我的项目中的 README 文件转换为 Markdown 并一直使用yard 验证文档是否正确呈现 所以我安装了 rdiscount 将 README 更改为 README md 并尝试 yard doc README md 这给了
  • 在 RMarkdown 输出到 PDF 时缩进而不添加项目符号点或编号

    之前有人问过如何在没有项目符号的情况下缩进文本 RMarkdown 中的点 但这是针对 HTML 输出的 在 RMarkdown 中缩进而不添加项目符号点或数字 https stackoverflow com questions 47087
  • 带 Markdown 的两栏布局

    我正在编写并排文本 我必须用两列布局来准备这个 例如 一列包含英文文本 其他列 右列包含前面 英文 文本的翻译 Markdown 不支持表格标记 但 Github Flavored Markdown 支持 我做了一些尝试 但不幸的是无法解决
  • 如何使用 R markdown 和 bookdown 将图形列表和表格列表添加到目录中

    我有一份报告 pdf 输出 我想在附录中添加参考书目 图表列表和表格列表 我希望这三个元素出现在目录中 我添加参考书目通过增加bibliography bibliography bib到我的 yaml 标头 我直接用 LaTex 添加的图形
  • 如何在 Markdown/pandoc 表中进行单元格垂直对齐?

    有没有办法在 markdown pandoc 中指定表格单元格内容的垂直对齐方式 Details 默认行为是居中对齐 我希望单元格内容与单元格顶部对齐 有关默认行为的示例 Something This is a very long line
  • 渲染以 Markdown 形式上传并在服务器端转换为 Html 的 Html 是否安全?

    我有一个网络表单 允许用户以 Markdown 形式上传文本 Markdown 在服务器上转换为 Html 使用 Markdig 并存储 当显示用户上传的转换后的 Html 时 我应该 Html Encode 内容 该项目采用 c MVC
  • 让 pandoc 对没有 h1 的部分进行编号

    当我用 markdown 编写文档时 为了用 pandoc 将其处理为 HTML 我总是有一个第一顺序的标题 Heading 即文档标题 以及二阶多个标题 Heading 但当我开机时 number sections在 pandoc 中 所
  • 如何从 Markdown 标题中删除锚链接?

    在 Github 中 当您创建 h2 或更小的标头 时 标头右侧会自动生成一个锚链接 当您单击此锚点时 它会将您链接到页面顶部具有该标题的页面 www myurl myheader 是否可以删除这个锚点 您可以禁用 Kramdown 的au
  • 如何将 HTML 转换为 Markdown?

    我有一个类似 stackoverflow 的网站 有一个文本区域 人们可以在其中写答案 我用这个 PHP 库 http parsedown org 转换降价 我的意思是我使用该函数来转换 italic to i italic i inclu
  • markdown/pandoc 的全站编译? [关闭]

    Closed 此问题正在寻求书籍 工具 软件库等的推荐 不满足堆栈溢出指南 help closed questions 目前不接受答案 With Sphinx doc http sphinx doc org 您可以创建一堆 ReStruct

随机推荐

  • C语言中的字符串转数字函数常见问题详解

    目录 C语言中的字符串转数字函数常见问题详解字符串转整形atoi函数 字符串转长整形strtol函数 xff0c C语言中的字符串转数字函数常见问题详解 字符串转整形 atoi函数 函数原型 xff1a int atoi const cha
  • 使用MATLAB进行三维空间绘图

    目录 使用MATLAB进行三维空间绘图一个入门例程matlab中的mesh 函数matlab中的meshgrid 函数matlab中的plot3函数例程代码解释 使用MATLAB进行三维空间绘图 三维图具有直观 立体的空间形象 xff0c
  • python特殊数据类型应用(2)元组类型

    目录 标题python特殊数据类型应用 xff08 2 xff09 元组类型元组的定义声明元组元组的访问元组和列表的相互转换元组和列表的区别 标题python特殊数据类型应用 xff08 2 xff09 元组类型 元组的定义 在python
  • python特殊数据类型应用(3)集合类型

    目录 python特殊数据类型应用 xff08 3 xff09 集合类型集合的定义集合的声明集合的运算集合元素的增加 xff1a 交集intersection 并集union差集difference xff1a 对称差集symmetric
  • python中字符串及其格式转换技巧

    目录 python中字符串及其格式转换技巧其他数据转为字符串字符串的格式化带格式限定符的格式化字符串的连接字符串切片字符串转换为 ASCII 值 python中字符串及其格式转换技巧 在python语言中 xff0c 对字符串的处理可以说是
  • Linux命令发送Http的get或post请求(curl和wget两种方法)

    xfeff xfeff Http请求指的是客户端向服务器的请求消息 xff0c Http请求主要分为get或post两种 xff0c 在Linux系统下可以用curl和wget命令来模拟Http的请求 下面就来介绍一下Linux系统如何模拟
  • 让bat文件后台运行

    让bat文件后台运行 文章目录 让bat文件后台运行 前言方法一方法二 前言 bat文件运行时会有一个黑黑的cmd exe窗口 xff0c 很吓人 xff0c 就算用start min命令去运行bat文件 xff0c 电脑的任务栏下仍然会有
  • 5.C语言中全局变量在多个文件中使用

    转自 xff1a https www eefocus com codevisionlife blog 13 12 300658 1a0b8 html 用C语言编写程序的时候 xff0c 我们经常会遇到这样一种情况 xff1a 希望在头文件中
  • 利用GitHub actions实现Docker Image的构建并传送到Docker Hub或者harbor

    目录 1 github actions的介绍 2 dockerfile 的编写 2 1 dockerfile 范例 2 2 其他指令 3 workflow的编写 3 1 上传到docker hub 3 2 上传到 harbor 4 结果展示
  • UCOSIII编写无人机飞控程序——第一篇

    研究无人机飞控已经接近两年 xff0c 作为一个业余的兴趣爱好 兴趣源于看到国外大神Raffaello D 39 Andrea在TED做的无人机演讲和展示 xff0c 感觉无人机很像工程师所施展的魔法 xff0c 给一向给人苦逼印象的工程师
  • 解决 Ubuntu :: Configure: Error: The QtCore Library >= 4.3.0 Could Not Be Found? 问题

    解决 Ubuntu Configure Error The QtCore Library gt 61 4 3 0 Could Not Be Found 问题 作者 19届YJF 日期 2020 10 2 这是我在打 robocup 2D仿真
  • 魔都,3年,程序员到CTO

    过一个平凡无趣的人生实在太容易了 xff0c 你可以不读书 xff0c 不冒险 xff0c 不运动 xff0c 不写作 xff0c 不外出 xff0c 不折腾 但是 xff0c 人生最后悔的事情就是 xff1a 我本可以 陈素封 我可以 在
  • 几种内存泄露检测工具的比较

    概述 内存泄漏 memory leak 指由于疏忽或错误造成程序未能释放已经不再使用的内存的情况 xff0c 在大型的 复杂的应用程序中 xff0c 内存泄漏是常见的问题 当以前分配的一片内存不再需要使用或无法访问时 xff0c 但是却并没
  • ubuntu查看磁盘占用和分配情况

    1 df hl Filesystem Size Used Avail Use Mounted on udev 978M 0 978M 0 dev tmpfs 200M 3 6M 197M 2 run dev sda5 28G 12G 15G
  • Android Studio主菜单(Main Menu)消失后,恢复显示

    当出现这个情况的时候 xff0c 我按找一般软件的办法找了半天也没找到 xff0c 最后没办法只能用万能的百度了 这里只记录一下当前我个人认为比较不错的方法 在Android Studio软件的右上角找到搜索 xff0c 输入Menu xf
  • github响应时间过长,无法访问此网站[已解决]

    某一天或某个时段总是出现 github 响应时间过长 xff0c 无法访问此网站的问题 获取github可以使用的DNS域名 通过站长工具 下的DNS查询 获取TTL值最小的 修改hosts配置 找到hosts xff08 域名解析文件 x
  • STM32(F407)—— 堆栈

    目录 1 SRAM 2 堆栈的作用 3 堆栈的设置 4 堆栈的实现 5 双堆栈机制 堆栈 是一种数据结构 堆栈都是一种数据项按序排列的数据结构 xff0c 只能在一端 称为栈顶 top 对数据项进行插入和删除 xff0c 相应地 xff0c
  • zabbix4.0学习五:Zabbix监控邮箱发送设置

    zabbix4 0学习五 xff1a Zabbix监控邮箱发送设置 文章目录 zabbix4 0学习五 xff1a Zabbix监控邮箱发送设置 前言配置centos安装mailx配置zabbix用户与报警媒介绑定 前言 zabbix里报警
  • STM32(F407)—— 存储区映射和存储器重映射

    Arm Cortex M4 处理器采用哈佛结构 xff0c 可以使用相互独立的总线来读取指令和加载 存储 数据 指令代码和数据都位于相同的存储器地址空间 xff0c 但在不同的地址范围 程序存储器 xff0c 数据存储器 xff0c 寄存器
  • MarkDown语法汇总

    文章目录 总览标题1 使用 号创建标题2 使用 61 和 号创建标题 段落1 换行2 字体格式3 删除线4 脚注5 下划线6 首行缩进7 字体颜色 大小 字体类型8 文本高亮 块引用1 嵌套块引用2 具有其他元素的块引用 列表1 有序列表2