.md文件格式语法详解，即markdown文件语法详解（图文并茂）

已于 2023-06-09 13:42:02 修改
阅读量10w+ 收藏 18
点赞数 6
文章标签： github markdown
于 2022-05-17 00:48:11 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/lishuoboy/article/details/124811716
版权

相关链接：

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

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

0.目录（非官网语法）(IDEA、码云、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)=(n−1)!∀n∈N 是通过 Euler integral

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

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 ↩︎

茅坑的小石头
关注
  • 6
    点赞
  • 踩
  • 18
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
Markdown语法详解
04-29
MarkDown是世界上最优美最简洁的写博客的语言，全部用法汇总如下，请慢用！! Markdowm语法001：标题 Markdowm语法002：引用 Markdown语法003：斜体和粗体、红色显示及其他字体颜色 Markdown语法004：链接和图片 Markdown语法005：分割线 Markdown语法006：中文首行缩进 Markdown语法007：表格 Markdown语法008：定义列表（有序列表、无序列表、缩进列表） Markdown语法009：行内代码和代码块 Markdown语法010：脚注 Markdown语法011：目录 Markdown语法012：UML 图（序列图和流程图） Markdown语法:013：离线写博客 Markdown语法014：浏览器兼容 Markdown语法015：快捷键 Markdown语法016：总结
Markdown语法及快捷键.md
03-22
Markdown语法及快捷键
【保姆及教程】简直不要太爽了！md文件图床工具picgo配合typora和阿里云oss存储，实现文md文件的复制转贴
m0_69311549的博客
03-16 415
【picgo图床工具使用教程】
集成editor.md的dokuwiki（支持markdown）
08-10
集成editor.md的dokuwiki（支持markdown）
markdown语法.md
08-24
md
MarkDown语法.md
07-29
markdown文件的简单示例,其中内容是markdown的部分简单语法 仅供简单参考,.md文件,用来给需要的朋友看的~
.md文件格式详解，即markdown文件语法（图文并茂），新生代农民工必备技能
热门推荐
【小石头的茅坑】
02-21 35万+
对于程序员，经常用github、码云等，对于md很常见了。 Markdown 是一种轻量级标记语言，。 它允许人们使用易读易写的纯文本格式编写文档，然后转换成有效的HTML文档。 由于 Markdown 的轻量化、易读易写特性，并且对于图片，图表、数学式都有支持，许多网站都广泛使用 Markdown 来撰写帮助文档或是用于论坛上发表消息。 如GitHub、Reddit、Diaspora、Stack Exchange、OpenStreetMap、SourceForge、简书等，甚至还能被使用来撰写电子..
.md文件以及markdown语法书写md文档
weixin_42454243的博客
06-06 5702
Typora的基础使用方法，详细见https://www.cnblogs.com/wonux/p/15693229.html
.md文件是什么？.md如何打开？怎么打开？
HouHouEr的博客
08-20 21万+
可能有些朋友会看到以md为结尾的文件，但是不知道用什么打开。下面就来说一下.md文件如何打开，markdown文件用什么打开。 　　1、首先来普及一下什么是md文件， md全称markdown，markdown也是一种标记语言。　　 　　2、md文件其实可以用常用的文本编辑器都可以打开，例如记事本、EditPlus、sublime等等。　　 　　3、用记事本打开，把markdown文件拖到记事本图标上就可以打开 。　　 　　 　　4、用 sublime打开方法也一样 ，当然也可以在文件上右击选择打
md文件的相关使用
枯葉
01-10 4347
天已雪，一杯否？ —— 南风落尽 前言 因为天冷，已经很久没有更新博客了，想了想，还是觉得写一篇水文，一是促使自己记得写文章，二是记录自己平时学到的杂七杂八的东西，免得忘了又到处找。于是就有了接下来的一篇水文。客官，天太冷，待我煮壶热茶，我们边喝边看可好？ 什么是md文件 md全称markdown，markdown也是一种标记语言。该类型文件可使用普通编辑器打开或者编辑，例如：记事本，EditPlus，sublime等等，当然了，也有更专业的编辑器，例如我现在正在使用的——Typora。 md文件的书写格
md 文件的常用编辑介绍
骏马逸动，心随你动的博客
03-30 1万+
正文： 1、标题的几种写法： 第一种： 前面带#号，后面带文字，分别表示h1-h6,上图可以看出，只到h6，而且h1下面会有一条横线，注意，#号后面有空格 第二种： 这种方式好像只能表示一级和二级标题，而且=和-的数量没有限制，只要大于一个就行 第三种： 这里的标题支持h1-h6，为了减少篇幅，我就偷个懒，只写前面二个，这个比较好理解，相当于标签闭合，注意，标题与#号要有空格 那既然3种都可以使用，可不可以混合使用呢？我试了一下，是可以的，但是为了让页面标签的...
常用markdown语法.md
12-31
markdown常用语法
Typora For Markdown 语法.md
08-18
想要写出一篇好的博客，或者使用markdown记录笔记，那么markdown的语法是我们必须要学的，这是typora for markdown语法的整理，博客使用markdown编写的话，语法相同
Typora-Markdown基础语法学习.md
09-04
关于Markdown常用语法的简单介绍
windows修改注册表 增加右键新增.md文件选项
06-28
使用方法：windows系统用户下载后直接运行即可，运行后会提示将会修改注册表。 使用Typora之类markdown编辑器的小伙伴们 是否经常需要新建.md文件却找不到快捷选项，只能通过修改.txt文件的后缀名来达到目的。 该文件是windows系统的注册表处理文件。直接运行该文件可以为右键快捷选项添加新建.md文件的快捷选项
Github 2024-04-28 开源项目日报 Top10
老孙正经胡说
04-28 1229
根据Github Trendings的统计，今日(2024-04-28统计)共有10个项目上榜。
Github2024-04-28php开源项目日报Top9
老孙正经胡说
04-28 1347
根据Github Trendings的统计，今日(2024-04-28统计)共有9个项目上榜。
GitHub Copilot申请和使用
最新发布
2301_78630677的博客
04-29 687
之前已经成功进行了Github学生认证，今天邮件通知之前的学生认证已经通过。那么就去进行GitHub Copilot申请和使用。Github学生认证成功实现GitHub Copilot申请和使用–2024/4/29。
使用Github+Picgo+npm实现免费图床
Yonagi的博客
04-29 1115
写博客的时候经常需要各种图片来丰富自己的博客内容，因此我们需要一个好的图床。市面上虽有不少好的图床，但大多需要收费，本文介绍了使用Github+npm的方式来做图床，基于npm的高速节点来保存/获取博客中的图片
markdown语法 文档 下载 *.md
08-29
Markdown语法是一种轻量级标记语言，它被广泛用于撰写文档。通过使用简单的标记符号，我们可以快速地为文本添加格式，如标题、列表、链接和图片等。 对于下载Markdown语法文档（*.md文件），我们可以采取以下步骤： 1. 打开一个Markdown文档，可以使用任何文本编辑器，如Notepad++、Sublime Text或Visual Studio Code等。 2. 在编辑器中输入或复制粘贴Markdown文本。Markdown文本可以包含标题、段落、列表、链接、图片等。 3. 保存Markdown文档。选择文件菜单中的“保存”选项，或者使用快捷键Ctrl + S保存。 4. 在保存时，选择一个目录作为文件保存的位置。确保文件扩展名为.md，表示它是一个Markdown文件。 5. 使用浏览器或Markdown编辑器打开下载的Markdown文档。这些工具可以帮助你查看Markdown文档的实时效果，并提供其他编辑和格式化选项。 通过以上步骤，我们可以下载一个包含Markdown语法的文档(*.md)，并在适当的编辑器或工具中打开和编辑它。Markdown语法简单易学，适合用于快速撰写文档，也适用于在线协作和版本控制，因此在软件开发、文档编写和写作领域得到了广泛的应用。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

茅坑的小石头

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值