分享

超神级!Markdown最详细教程,程序员的福音

 微笑如酒 2024-03-28 发布于广东

 图片

基本语法

标题

(1) # :表示标题。【推荐使用】    

基本语法: #   空格 + 标题名 # 的个数表示标题级别,为1-6级。

语法:# 一级标题## 二级标题### 三级标题#### 四级标题##### 五级标题###### 六级标题

(2)  -  或者  = :一级标题/二级标题 【不推荐】    

= 表示二级标题; - 表示一级标题;用至少2个的 - 或者至少2个的进行分割。

语法:用 - 表示标题----------用 = 表示标题===========

粗体和斜体

粗体

  • 前后各2个 * 包裹加粗内容。

语法:**粗体内容**

斜体

  • 前后各1个  * 包裹斜体内容。

语法:*斜体内容*

列表

有序列表

  •  数字序号 +  英文句号 +  空格 + 列表内容 来标记.

语法:1. 苹果手机2. 华为手机

无序列表

  1.  -    + 空格  +  列表内容    表示。

  2.  *    + 空格  列表内容   表示。

  3.  +   + 空格  +   列表内容    表示。

语法:+ 无序列表* 无序列表- 无序列表

水平线

  •   :  三个以上的   -  表示。 

  •  *  :  三个以上的   *  表示  

  •  _  :  三个以上的   _  表示

------ -表示水平线****** *表示水平线______ _表示水平线

块引用

 用 > + 空格  表示。注意:有的有时候,不需要空格。多层可以进行嵌套。

语法:> 第一层> > 第二层> > > 第三层> > > > 第四层

代码块

(1)用 `  表示。【推荐使用,效果好】
(2) 以 Tab 键 表示。【不推荐,效果不明显】
(3)4个空格 开头表示。【不推荐,效果不明显】

行内代码块:

(1) 用前后各1个(或2个) ` 包裹代码内容 。

多行代码演示:

(1)用前后各3个  包裹代码内容。

代码演示:`行内代码````多行代码```

图片引入

(1)用   + [图片说明] + (图片地址)  表示。

代码演示:![测试](D:\Users\Administrator\桌面\images\image-20240130133721558.png)

(2) 用html标签:

<img src='D:\Users\Administrator\桌面images\image-20240130133721558.png' alt='测试' style='zoom:33%;' />

链接

文字链接

  • 用   [链接文字](链接地址 '链接提示')  表示。

  1. 链接文字:真实显示的文字内容。

  2. 链接地址:点击链接文字跳转的地址。

  3. 链接提示:鼠标停留链接文字时,提示说明。

语法:[百度一下](https://www.baidu.com  '百度地址')[百度一下](https://www.baidu.com)

网址链接

(1)用  <网址地址>  表示,用  <>  包裹具体网址即可。
(2)用  <邮箱地址>  表示,用  <>  包裹邮箱地址即可。
语法:<http://www.baidu.com> 网址地址。<baidu@163.com> 邮箱地址。

超索引链接

(1)用  [链接文字][超索引定义]  表示。

  1. 链接文字:加超链接效果的文本。

  2. 超索引定义:真实的指向网址地址定义。

语法:[参见百度官网][target]
[target]:http://www.baidu.com '鼠标停留文字显示'

表格

用多个  进行分割,表示单元格。用 -   :  进行组合表示对齐方式。 注意:完整的表格需要至少由单元格和对其方式组成。也就是说至少两行。

  •  -:  设置内容和标题栏居右对齐。

  •  :-  设置内容和标题栏居左对齐。

  • :-:  设置内容和标题栏居中对齐

代码:|          chat| A       |    B    | C       ||-------------:|:--------|:-------:|---------||  chat| A       |    B    | C       ||          chat| A       |    B    | C       || chat| A | B | C |

任务列表

用   -  + 空格 +  [空格/x]   表示。

  • [ ]: 表示未选中。

  • [x]: 表示选中。

代码演示:- [x] 苹果- [x]  橡胶+ [ ] 橘子* [ ] 菠萝

锚点

(1)对标题标题的设置锚点:用 [锚点描述](#锚点名称)  表示。其中#+ 名称,对应的时1-6级标题的定义。

代码演示:# 第一章## 第二节

[第一章锚点](#第一章)[第二节锚点](##第二节)

(2)代码定义锚点:用html代码定义一个唯一的Id,如:<span id = 'jump'>跳转到的位置</span>,定义锚点链接。

代码演示:<span id = 'jump'>跳转到的位置</span>


[跳转](#jump)

删除文字

(1)用前后各2个 ~ 包裹删除内容。

代码演示:~~删除内容~~

表情符号

(1)用   +  符号  +  :   表示。注意:部分工具支持,但是在Idea中无法实现。

代码演示::smile_cat::signal_strength:

Markdown书写建议:

  1. 文档标题:文档的第一个标题应该是一级标题,写在第一行,建议与文件名相同,标题要尽量简短。

  2. 作者:可选,用于声明文档的作者,如果是开源项目的文档,建议把作者名写在修订历史中。

  3. 摘要:用1~3句话描述文档的核心内容。

  4. 目录:用于快速了解文档的结构,便于导航。

  5. 正文:正文中的标题从二级目录开始,逐级增加,不可跳级,不可相同。

    本站是提供个人知识管理的网络存储空间,所有内容均由用户发布,不代表本站观点。请注意甄别内容中的联系方式、诱导购买等信息,谨防诈骗。如发现有害或侵权内容,请点击一键举报。
    转藏 分享 献花(0

    0条评论

    发表

    请遵守用户 评论公约

    类似文章 更多