.md文件格式语法详解,即markdown文件语法详解(图文并茂)

article/2025/10/12 9:03:43

相关链接:

  1. 官网地址
  2. 博客地址。截图
  3. 博客地址。markdown版本,点击编辑
  4. 源码地址。需IDEA克隆代码,用IDEA打开

Markdown 是一种轻量级的标记语言,本质是html。不同应用对md的支持度不一致(方言),需要注意。

0.目录(非官网语法)(IDEA、码云、github 不支持)

文章目录

  • 0.目录(非官网语法)(IDEA、码云、github 不支持)
  • 1.标题(h1~h6标签)
    • 1.1 一般标题
  • 一级标题
    • 二级标题
      • 三级标题
        • 四级标题
          • 五级标题
            • 六级标题
  • 一级标题
    • 二级标题
    • 1.2 标题编号(扩展语法)(IDEA、github、码云、Typora、CSDN 不支持)
      • 带编号的标题{#custom-id}
  • 2.段落(p标签)
  • 3.换行(br标签)
  • 4.文字格式
    • 4.1.强调(em+strong标签)
    • 4.2.删除线(扩展语法)(del标签)
    • 4.3.其它非官网
  • 5.引用(blockquote标签)
  • 6.列表
    • 6.1.有序列表(ol标签)
    • 6.2.无序列表(ul标签)
    • 6.3.任务列表(扩展语法)
    • 6.4 自定义列表(扩展语法)(dl标签)(IDEA、github、码云、Typora 不支持)
  • 7.代码(code标签)
    • 7.1.代码
    • 7.2.代码块
  • 8.分割线(hr标签)
  • 9.链接(a标签)
    • 9.1.超链接
    • 9.2.网址和Email地址
    • 9.3.引用类型链接(Typora 不支持)
  • 10.图片(img标签)
  • 11.Markdown 转义字符(IDEA 不支持)
  • 12.内嵌 HTML 标签
    • 12.1 行级內联标签
    • 12.2 区块标签
  • 13.表格(扩展语法)(table系列标签)
  • 14.围栏代码块(扩展语法)(code标签)
    • 14.1 普通围栏代码块
    • 14.2 高亮围栏代码块
    • 14.3 其它非官网语法
      • 14.3.1 公式(IDEA、Typora、有道云 不支持)
      • 14.3.2 math(IDEA、github、码云、Typora、CSDN 不支持)
      • 14.3.3 graph 流程图(IDEA支持但是需下载 mermaid 扩展;有道云支持但是不能有mermaid)
      • 14.3.4 flowchat 流程图(IDEA、github、码云、Typora、有道云 不支持)
      • 14.3.5 UML时序图(IDEA支持但是需下载 mermaid 扩展;有道云支持但是不能有mermaid)
      • 14.3.6 甘特图(IDEA支持但是需下载 mermaid 扩展;有道云支持但是不能有mermaid)
      • 14.3.7 类图(IDEA支持但是需下载 mermaid 扩展;Typora、有道云 不支持)
  • 15.脚注(扩展语法)
  • 16.Emoji 表情(扩展语法)(IDEA、有道云不支持)
  • 17.自动网址连接(扩展语法)
  • 18.注释(非官网语法)(github、码云 不支持)

1.标题(h1~h6标签)

不同的 Markdown 应用程序处理 # 和标题之间的空格方式并不一致。为了兼容考虑,请用一个空格在 # 和标题之间进行分隔。

1.1 一般标题

一级标题

二级标题

三级标题

四级标题

五级标题
六级标题

一级标题

二级标题

1.2 标题编号(扩展语法)(IDEA、github、码云、Typora、CSDN 不支持)

带编号的标题{#custom-id}

链接到带编号的标题

2.段落(p标签)

  • 要创建段落,请使用空白行将一行或多行文本进行分隔。

  • 不要用空格(spaces)或制表符( tabs)缩进段落。

段落1

段落2

3.换行(br标签)

在一行的末尾添加两个或多个空格,然后按回车键,即可创建一个换行。

hello
world

或反斜杠

hello
world

4.文字格式

4.1.强调(em+strong标签)

Markdown 应用程序在如何处理单词或短语中间的下划线上并不一致。为兼容考虑,在单词或短语中间部分加粗的话,请使用星号(asterisks)。不要空格。

斜体-推荐(em标签非i标签)

粗体-推荐(strong标签)

粗+斜体-推荐(em+strong标签)

斜体-不推荐(em标签非i标签)

粗体-不推荐(strong标签)

粗+斜体-不推荐(em+strong标签)

4.2.删除线(扩展语法)(del标签)

删除线

4.3.其它非官网

下划线

++下划线2(IDEA、github、码云、Typora、CSDN 不支持)++

标记黄底(IDEA、github、码云、Typora 不支持)

下标 H2O(IDEA、github、码云、Typora 不支持)

上标 210(IDEA、github、码云、Typora 不支持)

5.引用(blockquote标签)

引用

多段落引用。也可以用结尾两个空格换行

多段落引用。块引用可以包含多个段落。为段落之间的空白行添加一个 > 符号。

嵌套块引用

嵌套块引用
嵌套块引用

6.列表

6.1.有序列表(ol标签)

CommonMark 和其他一些轻量级标记语言允许您使用括号“)” 作为分隔符(例如,1) 第一项),但并非所有 Markdown 应用程序都支持这一点,因此从兼容性角度来看,这不是一个很好的选择。为了兼容性,仅使用句点。

  1. 一级
    1. 二级
      1. 三级
  2. 一级

6.2.无序列表(ul标签)

要创建无序列表,请在每个列表项前面添加“减号” (-)、星号 (*) 或加号 (+) 。缩进一个或多个列表项可创建嵌套列表。

为了兼容性,不要在同一个列表中混合和匹配分隔符 - 选择一个并坚持使用它。

  • 一级
    • 二级
      • 三级
  • 一级
    • 二级
      • 三级

在列表中嵌套其他元素

  • 第一条

    描述

    描述
    

    描述

  • 第二条

6.3.任务列表(扩展语法)

  • 完成任务列表
  • 完成任务列表
  • 未完成任务列表
  • 未完成任务列表

6.4 自定义列表(扩展语法)(dl标签)(IDEA、github、码云、Typora 不支持)

一些Markdown处理器允许您创建术语及其对应定义的定义列表。要创建定义列表,请在第一行上键入术语。在下一行,键入一个冒号,后跟一个空格和定义。

Markdown
Text-to- HTML conversion tool
Authors
John
Luke

7.代码(code标签)

7.1.代码

System.out.println(hello)

转义反引号

System.out.println(`hello`)

7.2.代码块

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

要创建不用缩进的代码块,请使用 围栏式代码块(fenced code blocks)

可以方式html代码被渲染

<html><body>不被渲染</body>
</html>
空格不够,被渲染

8.分割线(hr标签)

要创建分隔线,请在单独一行上使用三个或多个型号(*)、破折号 (-) 或下划线 (_) ,并且不能包含其他内容。

为了兼容性,请在分隔线的前后均添加空白行。




9.链接(a标签)

不同的 Markdown 应用程序处理URL中间的空格方式不一样。为了兼容性,请尽量使用%20代替空格。

9.1.超链接

链接文本放在中括号内,链接地址放在后面的括号中,链接title可选。

超链接Markdown语法代码:超链接显示名

百度

百度带title

9.2.网址和Email地址

使用尖括号可以很方便地把URL或者email地址变成可点击的链接。

https://www.baidu.com

lishuoboy@163.com (IDEA、CSDN、有道云 不支持)

9.3.引用类型链接(Typora 不支持)

引用连接,请打开百度

下面连接一般写在文章末尾

10.图片(img标签)

插入图片Markdown语法代码:![图片alt](图片链接 "图片title")

这是图片

带链接的图片:

链接图片

CSDN带格式的图片(IDEA、github、码云、Typora、有道云 不支持)

居中的图片:
Alt

居中并且带尺寸的图片:
Alt

居右的图片:
Alt

带尺寸的图片:
Alt

宽度确定高度等比例的图片:
Alt

高度确定宽度等比例的图片:
Alt

11.Markdown 转义字符(IDEA 不支持)

要显示原本用于格式化 Markdown 文档的字符,请在字符前面添加反斜杠字符 \ 。

斜体用*斜体*

粗体用**粗体**

12.内嵌 HTML 标签

对于 Markdown 涵盖范围之外的标签,都可以直接在文件里面用 HTML 本身。如需使用 HTML,不需要额外标注这是 HTML 或是 Markdown,只需 HTML 标签添加到 Markdown 文本中即可。

12.1 行级內联标签

HTML 的行级內联标签如 <span>、<cite>、<del> 不受限制,可以在 Markdown 的段落、列表或是标题里任意使用

这个 词语 是加粗的。这个 词语 是斜体

加粗

12.2 区块标签

区块元素──比如<div>、<table>、<pre>、<p> 等标签,必须在前后加上空行,以便于内容区分。而且这些元素的开始与结尾标签,不可以用 tab 或是空白来缩进。Markdown 会自动识别这区块元素,避免在区块标签前后加上没有必要的 <p> 标签。

Foo

请注意,Markdown 语法在 HTML 区块标签中将不会被进行处理。例如,你无法在 HTML 区块内使用 Markdown 形式的*强调*。

13.表格(扩展语法)(table系列标签)

  • 要添加表,请使用三个或多个连字符(—)创建每列的标题,并使用管道(|)分隔每列。您可以选择在表的任一端添加管道。

  • 您可以在表格中设置文本格式。例如,您可以添加链接,代码(仅反引号(`)中的单词或短语,而不是代码块)和强调。您不能添加标题,块引用,列表,水平规则,图像或HTML标签。

  • 您可以使用表格的HTML字符代码(|)在表中显示竖线(|)字符。

默认(对齐方式与软件有关)姓名左对齐姓名右对齐姓名居中对齐
张三张三张三张三
李四李四李四李四

14.围栏代码块(扩展语法)(code标签)

Markdown基本语法允许您通过将行缩进四个空格或一个制表符来创建代码块。如果发现不方便,请尝试使用受保护的代码块。根据Markdown处理器或编辑器的不同,您将在代码块之前和之后的行上使用三个反引号(`)或三个波浪号(~)。

14.1 普通围栏代码块

{"id": 1,"name": "张三"
}
{"id": 1,"name": "张三"
}
{"id": 1,"name": "张三"
}

14.2 高亮围栏代码块

{"id": 1,"name": "张三"
}

<root><id>1</id><name>张三</name>
</root>
/** 注释 */
public class User {private String name;  // 姓名
}
/** 注释 */
function getName() {return "张三";  // 姓名
}

14.3 其它非官网语法

14.3.1 公式(IDEA、Typora、有道云 不支持)

E = m c 2 E = mc^2 E=mc2

Gamma公式展示 Γ ( n ) = ( n − 1 ) ! ∀ n ∈ N \Gamma(n) = (n-1)!\quad\forall n\in\mathbb N Γ(n)=(n1)!nN 是通过 Euler integral

Γ ( z ) = ∫ 0 ∞ t z − 1 e − t d t . \Gamma(z) = \int_0^\infty t^{z-1}e^{-t}dt\,. Γ(z)=0tz1etdt.

14.3.2 math(IDEA、github、码云、Typora、CSDN 不支持)

E = mc^2
\Gamma(z) = \int_0^\infty t^{z-1}e^{-t}dt\,.

14.3.3 graph 流程图(IDEA支持但是需下载 mermaid 扩展;有道云支持但是不能有mermaid)

A
B
链接
长方形
圆角长方形
菱形

14.3.4 flowchat 流程图(IDEA、github、码云、Typora、有道云 不支持)

Created with Raphaël 2.3.0 开始 我的操作 确认? 结束 yes no

14.3.5 UML时序图(IDEA支持但是需下载 mermaid 扩展;有道云支持但是不能有mermaid)

A B How are you? Great! A B
张三 李四 王五 你好!李四, 最近怎么样? 你最近怎么样,王五? 我很好,谢谢! 我很好,谢谢! 李四想了很长时间, 文字太长了 不适合放在一行. 打量着王五... 很好...王五, 你怎么样? 张三 李四 王五

14.3.6 甘特图(IDEA支持但是需下载 mermaid 扩展;有道云支持但是不能有mermaid)

2014-01-01 2014-01-03 2014-01-05 2014-01-07 2014-01-09 2014-01-11 2014-01-13 2014-01-15 2014-01-17 2014-01-19 T1 T3 T2 S1 S2 S3
2014-01-06 2014-01-07 2014-01-08 2014-01-09 2014-01-10 2014-01-11 2014-01-12 2014-01-13 2014-01-14 2014-01-15 2014-01-16 2014-01-17 已完成 进行中 计划中 现有任务 Adding GANTT diagram functionality to mermaid

14.3.7 类图(IDEA支持但是需下载 mermaid 扩展;Typora、有道云 不支持)

Cool
Where am i?
«interface»
Class01
int chimp
int gorilla
size()
AveryLongClass
Class09
C2
C3
Class07
Object[] elementData
equals()
Class10
>>service>>
int id
size()

15.脚注(扩展语法)

引用URL。1

引用本地文件。2

下面的链接一般写文档末尾

16.Emoji 表情(扩展语法)(IDEA、有道云不支持)

有两种方法可以将表情符号添加到Markdown文件中:将表情符号复制并粘贴到Markdown格式的文本中,或者键入emoji shortcodes。

去露营了! ⛺️ 很快回来。

真好笑! 😂

17.自动网址连接(扩展语法)

许多Markdown处理器会自动将URL转换为链接。这意味着如果您输入http://www.example.com,即使您未使用方括号,您的Markdown处理器也会自动将其转换为链接。

https://www.baidu.com

禁用自动URL链接

https://www.baidu.com

18.注释(非官网语法)(github、码云 不支持)


  1. http://www.baidu.com ↩︎

  2. .gitignore ↩︎


http://chatgpt.dhexx.cn/article/4dTx41uU.shtml

相关文章

md基本语法介绍

发现很多人都喜欢用.md&#xff08;markdown&#xff09;进行项目说明&#xff0c;眼馋其方便快捷的实用性&#xff0c;也学习一下&#xff0c;做个简单的笔记 1、标题修饰符 ‘#’ 标题分为h1~h6以#为标识符&#xff0c;#号的多少划分等级,而且仅有h1,h2是有下划线的&#xf…

Markdown最详细的语法教程,.md文件解读

.md即markdown文件的基本常用编写语法,是一种快速标记、快速排版语言&#xff0c;现在很多前段项目中的说明文件readme等都是用.md文件编写的&#xff0c;而且很多企业也在在鼓励使用这种编辑方式&#xff0c;特别作为一个前端从业者更要学会使用这种语言。 当然这种语言更适合…

.md 基本常用编写语法

.md文件基本常用编写语法 1.标题 第一种&#xff1a; # 一级标题 ## 二级标题 ### 三级标题 #### 四级标题 ##### 五级标题 ###### 六级标题一级标题 二级标题 三级标题 四级标题 五级标题 六级标题 ​ 前面带#号&#xff0c;后面带文字&#xff0c;分别表示h1-h6,上图…

MD语法 官方参考

这里写自定义目录标题 欢迎使用Markdown编辑器新的改变功能快捷键合理的创建标题&#xff0c;有助于目录的生成如何改变文本的样式插入链接与图片如何插入一段漂亮的代码片生成一个适合你的列表创建一个表格设定内容居中、居左、居右SmartyPants 创建一个自定义列表如何创建一个…

【md】1.markdown基础语法

一、基本文本使用 不是程序员的话&#xff0c;推荐只看本部分。后续的操作虽然也会用到部分&#xff0c;但频率很低&#xff0c;用的时候直接从目录跳转即可。 1、换行 直接回车。 2、段落 &#xff08;1&#xff09;、格式 换行两次 &#xff08;2&#xff09;、区别富…

.MD语法

.md即markdown文件的基本常用编写语法,是一种快速标记、快速排版语言&#xff0c;现在很多前段项目中的说明文件readme等都是用.md文件编写的&#xff0c;而且很多企业也在在鼓励使用这种编辑方式&#xff0c;特别作为一个前端从业者更要学会使用这种语言。下面就简单和大家分享…

md文档语法大全

目录 基本符号 标题 # 文字 # 文字 # 列表 无序列表 有序列表 嵌套列表 引用块 行引用 嵌套引用 代码块 链接 图片 分割线 表格 复选框 换行 其他 基础不牢&#xff0c;地动山摇&#xff0c;好的文档是项目质量及后续可维护的一个重要因素&#xff0c;每次…

PHPRunner 10.7.0 PHP代码生成器

PHPRunner 10.7.0 PHP代码生成器。 使用 PHPRunner 构建现代、功能丰富、响应迅速、数据驱动的 Web 应用程序。连接到 MySQL、SQL Server、MS Access 和 Oracle。这种快速的应用程序开发/低代码软件将使您的交付速度提高多达 90% - 它对于初学者来说很容易使用&#xff0c;但对…

generate-code开源的代码生成器(FlierTeam)

generate-code开源的代码生成器 一、背景二、项目链接三、功能介绍&#xff08;一&#xff09;通用代码生成器代码生成切换数据源下载 &#xff08;二&#xff09;可修改模板的生成器模板管理 四、总结 一、背景 从开源项目&#xff1a;https://gitee.com/QinHaiSenLin/Jfinal…

5.6 Mybatis代码生成器Mybatis Generator (MBG)实战详解

文章目录 前言一、Mybatis Generator简介二、Maven插件运行方式三、生成配置 generatorConfig.xmlMyBatis3Simple风格MyBatis3风格MyBatis3DynamicSql风格 四、Java代码运行方式五、MGB生成全部表六、增加Ext包七、Git提交总结 前言 本文我们主要实战Mybatis官方的代码生成器&…

软著代码生成器

软著代码生成器 介绍使用说明 使用下载 介绍 软著代码生成器 自动生成word 自动删除注释单行注释(python c# 等)每页50行代码自动删除空行 使用说明 下载解压即可使用 使用 下载 gitee下载地址 觉得好用的客官, 欢迎star

mybatis代码生成器

mybatis代码生成器 步骤一&#xff1a;在pom中安装mybatis generator 自动生成代码插件 步骤二&#xff1a;复制代码生成器代码&#xff0c;修改数据库配置&#xff0c;及实体类生成的位置即可 步骤三&#xff1a;增加配置启动命令 步骤一&#xff1a;在pom中安装mybatis gener…

C# 源代码生成器

C# 源代码生成器 什么是源生成器源生成器允许执行两个主要操作Microsoft 文档模型图示常见方案源生成器的使用1、创建 .NET控制台应用程序2、创建源生成器项目3、在控制台程序中使用生成器项目 结语 什么是源生成器 源生成器是由.NET Compiler Platform&#xff08;“Roslyn”&…

vue代码生成器

直接根据swagger api生成vue代码 前要 目前的代码生成器基本上是基于数据库表格来生成对应的前后台代码&#xff0c;好处是前后台一次性搞定&#xff0e;但实际开发中&#xff0c;很多的业务是需要连表的&#xff0c;所以这种情况来说&#xff0c;根据接口直接生成前代码&#…

C#代码生成器

引言 引言&#xff1a;随着.net Core 的不断发展&#xff0c;它也是一个成熟的平台了&#xff0c;鲁迅说过&#xff1a;成熟的平台就要学会自己写代码&#xff0c;那么今天我就在这里教大家如何让.net Core学会自己写代码。 提示&#xff1a;如果只是向往&#xff0c;远方依旧…

MybatisPlus代码生成器

代码生成器 问题导入 如果只给一张表的字段信息&#xff0c;能够推演出Domain、Dao层的代码&#xff1f; 1. MyBatisPlus提供模板 Mapper接口模板 实体对象类模板 2. 工程搭建和基本代码编写 第一步&#xff1a;创建SpringBoot工程&#xff0c;添加代码生成器相关依赖&…

python 代码生成器_Python代码生成器(代码生成工具)V1.1 正式版

Python代码生成器(代码生成工具)是一款很优秀好用的为新手制作的代码生成助手。小编带来的这款Python代码生成器功能强大&#xff0c;操作简单&#xff0c;使用后可以帮助用户更轻松便捷的生成Python代码&#xff0c;非常方便实用。其内置了大量的示例代码&#xff0c;可以帮助…

12款AI代码生成工具,都很能打

1.Anania Anania 是一个机器人数据分析师&#xff0c;可以通过简单、自然的英语对话来分析您的数据。连接数据源并以简单的英语提问&#xff0c;无需任何设置或配置。在幕后&#xff0c;Anania 正在使用一个 AI 系统&#xff0c;该系统将文本转换为 SQL 和 Python 代码并执行您…

3D相册动态桌面制作

3D相册动态桌面制作 1.下载3D相册代码链接&#xff1a;https://pan.baidu.com/s/1Z_br3XKGsW3vsISvSCteJA&#xff0c;提取码&#xff1a;8888 更换自己喜欢的图片 注意第三张和第四章相册右键旋转照片 直接双击运行index.html可以在浏览器中看到效果。 如果不是很喜欢 可以自行…

HTML+CSS+JavaScript七夕情人节表白网页【樱花雨3D相册】超好看

这是程序员表白系列中的100款网站表白之一&#xff0c;旨在让任何人都能使用并创建自己的表白网站给心爱的人看。 此波共有100个表白网站&#xff0c;可以任意修改和使用&#xff0c;很多人会希望向心爱的男孩女孩告白&#xff0c;生性腼腆的人即使那个TA站在眼前都不敢向前表白…