# lishuoboy-markdown **Repository Path**: lishuoboy/lishuoboy-markdown ## Basic Information - **Project Name**: lishuoboy-markdown - **Description**: markdown教程(.md文件) - **Primary Language**: HTML - **License**: Not specified - **Default Branch**: master - **Homepage**: https://blog.csdn.net/lishuoboy/article/details/124809788 - **GVP Project**: No ## Statistics - **Stars**: 1 - **Forks**: 1 - **Created**: 2021-01-05 - **Last Updated**: 2025-06-24 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README
[![Fork me on Gitee](https://gitee.com/lishuoboy/lishuoboy-javase/widgets/widget_4.svg)](https://gitee.com/lishuoboy/lishuoboy-markdown)
**相关链接:** 1. [教程-中文官网](https://markdown.com.cn/) 2. [教程-CSDN-图文对照版](https://blog.csdn.net/lishuoboy/article/details/104421044) 3. [源码-CSDN(点击编辑)](https://blog.csdn.net/lishuoboy/article/details/124811716) 4. [源码-gitee(下载README.md文件,用IDEA等编辑器打开)](https://gitee.com/lishuoboy/lishuoboy-markdown) Markdown 是一种轻量级的标记语言,本质是html。不同应用对md的支持度不一致(方言),需要注意。 # 0.目录(非官网语法)(IDEA、码云、github 不支持) [toc] # 1.标题(h1~h6标签) 不同的 Markdown 应用程序处理 # 和标题之间的空格方式并不一致。为了兼容考虑,请用一个空格在 # 和标题之间进行分隔。 ## 1.1 一般标题 # 一级标题 ## 二级标题 ### 三级标题 #### 四级标题 ##### 五级标题 ###### 六级标题 一级标题 == 二级标题 -- ## 1.2 标题编号(扩展语法)(IDEA、github、码云、Typora、CSDN 不支持) ### 带编号的标题{#custom-id} [链接到带编号的标题](#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 不支持)== 下标 H~2~O(IDEA、github、码云、Typora 不支持) 上标 2^10^(IDEA、github、码云、Typora 不支持) # 5.引用(blockquote标签) > 引用 > 多段落引用。也可以用结尾两个空格换行 > > 多段落引用。块引用可以包含多个段落。为段落之间的空白行添加一个 > 符号。 > 嵌套块引用 >> 嵌套块引用 > > 嵌套块引用 # 6.列表 ## 6.1.有序列表(ol标签) CommonMark 和其他一些轻量级标记语言允许您使用括号“)” 作为分隔符(例如,1) 第一项),但并非所有 Markdown 应用程序都支持这一点,因此从兼容性角度来看,这不是一个很好的选择。为了兼容性,仅使用句点。 1. 一级 1. 二级 1. 三级 2. 一级 ## 6.2.无序列表(ul标签) 要创建无序列表,请在每个列表项前面添加“减号” (-)、星号 (*) 或加号 (+) 。缩进一个或多个列表项可创建嵌套列表。 为了兼容性,不要在同一个列表中混合和匹配分隔符 - 选择一个并坚持使用它。 - 一级 - 二级 - 三级 - 一级 + 二级 * 三级 **在列表中嵌套其他元素** - 第一条 描述 描述 > 描述 - 第二条 ## 6.3.任务列表(扩展语法) - [x] 完成任务列表 - [x] 完成任务列表 - [ ] 未完成任务列表 - [ ] 未完成任务列表 ## 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代码被渲染 不被渲染 空格不够,被渲染 # 8.分割线(hr标签) 要创建分隔线,请在单独一行上使用三个或多个型号(*)、破折号 (-) 或下划线 (_) ,并且不能包含其他内容。 为了兼容性,请在分隔线的前后均添加空白行。 *** --- ___ # 9.链接(a标签) 不同的 Markdown 应用程序处理URL中间的空格方式不一样。为了兼容性,请尽量使用%20代替空格。 ## 9.1.超链接 链接文本放在中括号内,链接地址放在后面的括号中,链接title可选。 超链接Markdown语法代码:[超链接显示名](超链接地址"超链接title") [百度](https://www.baidu.com) [百度带title](https://www.baidu.com "光标放连接上显示title") ## 9.2.网址和Email地址 使用尖括号可以很方便地把URL或者email地址变成可点击的链接。 (IDEA、CSDN、有道云 不支持) ## 9.3.引用类型链接(Typora 不支持) 引用连接,请打开[百度] 下面连接一般写在文章末尾 [百度]: https://www.baidu.com # 10.图片(img标签) 插入图片Markdown语法代码:`![图片alt](图片链接 "图片title")` ![这是图片](https://imgconvert.csdnimg.cn/aHR0cHM6Ly9hdmF0YXIuY3Nkbi5uZXQvNy83L0IvMV9yYWxmX2h4MTYzY29tLmpwZw "Magic Gardens") 带链接的图片: [![链接图片](https://imgconvert.csdnimg.cn/aHR0cHM6Ly9hdmF0YXIuY3Nkbi5uZXQvNy83L0IvMV9yYWxmX2h4MTYzY29tLmpwZw#pic_center "Shiprock")](https://www.baidu.com) **CSDN带格式的图片**(IDEA、github、码云、Typora、有道云 不支持) 居中的图片: ![Alt](https://imgconvert.csdnimg.cn/aHR0cHM6Ly9hdmF0YXIuY3Nkbi5uZXQvNy83L0IvMV9yYWxmX2h4MTYzY29tLmpwZw#pic_center) 居中并且带尺寸的图片: ![Alt](https://imgconvert.csdnimg.cn/aHR0cHM6Ly9hdmF0YXIuY3Nkbi5uZXQvNy83L0IvMV9yYWxmX2h4MTYzY29tLmpwZw#pic_center=30x30) 居右的图片: ![Alt](https://imgconvert.csdnimg.cn/aHR0cHM6Ly9hdmF0YXIuY3Nkbi5uZXQvNy83L0IvMV9yYWxmX2h4MTYzY29tLmpwZw#pic_right) 带尺寸的图片: ![Alt](https://imgconvert.csdnimg.cn/aHR0cHM6Ly9hdmF0YXIuY3Nkbi5uZXQvNy83L0IvMV9yYWxmX2h4MTYzY29tLmpwZw =30x30) 宽度确定高度等比例的图片: ![Alt](https://imgconvert.csdnimg.cn/aHR0cHM6Ly9hdmF0YXIuY3Nkbi5uZXQvNy83L0IvMV9yYWxmX2h4MTYzY29tLmpwZw =30x) 高度确定宽度等比例的图片: ![Alt](https://imgconvert.csdnimg.cn/aHR0cHM6Ly9hdmF0YXIuY3Nkbi5uZXQvNy83L0IvMV9yYWxmX2h4MTYzY29tLmpwZw =x30) # 11.Markdown 转义字符(IDEA 不支持) 要显示原本用于格式化 Markdown 文档的字符,请在字符前面添加反斜杠字符 \ 。 斜体用\*斜体\* 粗体用\*\*粗体\*\* # 12.内嵌 HTML 标签 对于 Markdown 涵盖范围之外的标签,都可以直接在文件里面用 HTML 本身。如需使用 HTML,不需要额外标注这是 HTML 或是 Markdown,只需 HTML 标签添加到 Markdown 文本中即可。 ## 12.1 行级內联标签 HTML 的行级內联标签如 `` 不受限制,可以在 Markdown 的段落、列表或是标题里任意使用 这个 **词语** 是加粗的。这个 词语 是斜体 加粗 ## 12.2 区块标签 区块元素──比如`
、、

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

` 标签。

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 高亮围栏代码块 ```json { "id": 1, "name": "张三" } ``` ```xml 1 张三 ``` ```java /** 注释 */ public class User { private String name; // 姓名 } ``` ```javascript /** 注释 */ function getName() { return "张三"; // 姓名 } ``` ## 14.3 其它非官网语法 ### 14.3.1 公式(IDEA、Typora、有道云 不支持) $$ E = mc^2 $$ Gamma公式展示 $\Gamma(n) = (n-1)!\quad\forall n\in\mathbb N$ 是通过 Euler integral $$ \Gamma(z) = \int_0^\infty t^{z-1}e^{-t}dt\,. $$ ### 14.3.2 math(IDEA、github、码云、Typora、CSDN 不支持) ```math E = mc^2 ``` ```math \Gamma(z) = \int_0^\infty t^{z-1}e^{-t}dt\,. ``` ### 14.3.3 graph 流程图(IDEA支持但是需下载 mermaid 扩展;有道云支持但是不能有mermaid) ```mermaid graph LR A -->B ``` ```mermaid graph LR A[长方形] -- 链接 --> B((圆)) A --> C(圆角长方形) B --> D{菱形} C --> D ``` ### 14.3.4 flowchat 流程图(IDEA、github、码云、Typora、有道云 不支持) ```mermaid flowchat st=>start: 开始 e=>end: 结束 op=>operation: 我的操作 cond=>condition: 确认? st->op->cond cond(yes)->e cond(no)->op ``` ### 14.3.5 UML时序图(IDEA支持但是需下载 mermaid 扩展;有道云支持但是不能有mermaid) ```mermaid sequenceDiagram A->>B: How are you? B->>A: Great! ``` ```mermaid sequenceDiagram 张三 ->> 李四: 你好!李四, 最近怎么样? 李四-->>王五: 你最近怎么样,王五? 李四--x 张三: 我很好,谢谢! 李四-x 王五: 我很好,谢谢! Note right of 王五: 李四想了很长时间, 文字太长了
不适合放在一行. 李四-->>张三: 打量着王五... 张三->>王五: 很好...王五, 你怎么样? ``` ### 14.3.6 甘特图(IDEA支持但是需下载 mermaid 扩展;有道云支持但是不能有mermaid) ```mermaid gantt dateFormat YYYY-MM-DD section S1 T1: 2014-01-01, 9d section S2 T2: 2014-01-11, 9d section S3 T3: 2014-01-02, 9d ``` ```mermaid gantt dateFormat YYYY-MM-DD title Adding GANTT diagram functionality to mermaid section 现有任务 已完成 :done, des1, 2014-01-06,2014-01-08 进行中 :active, des2, 2014-01-09, 3d 计划中 : des3, after des2, 5d ``` ### 14.3.7 类图(IDEA支持但是需下载 mermaid 扩展;Typora、有道云 不支持) ```mermaid classDiagram Class01 <|-- AveryLongClass : Cool <> Class01 Class09 --> C2 : Where am i? Class09 --* C3 Class09 --|> Class07 Class07 : equals() Class07 : Object[] elementData Class01 : size() Class01 : int chimp Class01 : int gorilla class Class10 { >>service>> int id size() } ``` # 15.脚注(扩展语法) 引用URL。[^1] 引用本地文件。[^2] 下面的链接一般写文档末尾 [^1]: http://www.baidu.com [^2]: .gitignore # 16.Emoji 表情(扩展语法)(IDEA、有道云不支持) 有两种方法可以将表情符号添加到Markdown文件中:将表情符号复制并粘贴到Markdown格式的文本中,或者键入emoji shortcodes。 去露营了! :tent: 很快回来。 真好笑! :joy: # 17.自动网址连接(扩展语法) 许多Markdown处理器会自动将URL转换为链接。这意味着如果您输入http://www.example.com,即使您未使用方括号,您的Markdown处理器也会自动将其转换为链接。 https://www.baidu.com 禁用自动URL链接 `https://www.baidu.com` # 18.注释(非官网语法) [//]: # (注释语法2:IDEA的) *[HTML]: 注释语法3(IDEA不支持)