Github上的Markdown语法详解

今天在看Win32文档参与编写的说明时,看到里面提及

复制代码
Our documentation is written in Markdown, a lightweight text style syntax. If you're not familiar with Markdown, you can learn the basics on GitHub. When unsure,

刚好,今天就来做个全面的总结 ,以后在github上写说明的时候,就更方便了。

标题

输入 # 空格 文本,就可以创建标题,如:

复制代码
# 一级标题

一级标题

复制代码
## 二级标题

二级标题

复制代码
### 三级标题

三级标题

文本样式

样式 语法 快捷键 示例 输出
加粗 ** ** 或者 __ __ Ctrl+B **加粗** 加粗
斜体 * * 或者 _ _ Ctrl+I *斜体* 斜体
删除线 ~~ ~~ ~~删除文本~~ 删除文本
加粗嵌套斜体 ** ** 和 _ _ **加粗中的_斜体_** 加粗中的_斜体_(博客园Markdown编辑器不支持这种格式,看不到显示效果)
加粗并斜体 *** *** ***加粗并斜体*** 加粗并斜体
下标 普通文本<sub>下标</sub> 普通文本下标
上标 普通文本<sup>上标</sup> 普通文本上标

引用文本

输入 > 空格 引用文本

复制代码
> 引用文本

引用文本

引用代码

输入 'code'```code```

复制代码
Hello `World`

Hello World

```

Hello World

```

复制代码
Hello World

语法高亮

```后输入语言名称 即可,完整的语言列表可以访问 https://github.com/github/linguist

```

Console.WriteLine("HelloWorld");

```

复制代码
Console.WriteLine("HelloWorld");

```c#

Console.WriteLine("HelloWorld");

```

复制代码
Console.WriteLine("HelloWorld");

颜色显示(支持 issues, pull requests, 和 discussions,说明文档是不支持这种语法格式的)

颜色模式 语法 示例 输出
HEX #RRGGBB 红色`#ff0000` 红色ff0000
RGB rgb(R,G,B) 黑色`rgb(0, 0, 0)` 黑色rgb(0, 0, 0)
HSL hsl(H,S,L) 白色`hsl(216, 0%, 100%)` 白色hsl(216, 0%, 100%)

超链接

输入 [显示内容](链接地址)

复制代码
[博客园](https://www.cnblogs.com)

博客园

链接到段落

如果我们想链接到文中的某一个位置。如下图所示。可以复制前面那个链接图标的地址

然后创建一个链接,如下:

复制代码
[实用工具](https://github.com/zhaotianff/Master-Zhao#实用工具)

实用工具

链接到项目文件

如果我们想链接到项目中的某一个文件,直接指定相对路径即可。以当前md文档所在的路径为根目录。./为当前目录../为上级目录../../为上上级目录 ,依此类推。xx/ 或**./xx/** 为当前路径下的xx目录,a/b 或**./a/b** 为当前a目录下的b目录,依此类推。

比如常用的开源协议文件,一般都会创建一个这样的链接,代表链接到当前路径下的LICENSE文件

复制代码
[CC0-1.0](./LICENSE).

复制代码
[CC0-1.0](LICENSE).

图片

输入 ![替代文本](图片地址) 就可以插入图片,图片地址可以是一个网络地址,也可以是当前项目下的。

复制代码
![alt text](https://img2.baidu.com/it/u=3155456000,3342398460&fm=253&fmt=auto&app=138&f=JPG?w=387&h=500)
复制代码
![logo](icon/logo.png)

但是这种方式有个缺点,就是图片不能居中,如果想要图片居中,可以使用p和img标签

复制代码
<p align="center">
    <img alt="alt text" src="https://img2.baidu.com/it/u=3155456000,3342398460&fm=253&fmt=auto&app=138&f=JPG?w=387&h=500" />
</p>

列表

输入 * 空格 列表项- 空格 列表项

复制代码
* 列表项1
* 列表项2
  • 列表项1

  • 列表项2

    • 列表项1
    • 列表项2
  • 列表项1

  • 列表项2

列表嵌套

列表嵌套也是使用跟创建列表一样的语法,但是嵌套符号要和上级列表的首字符对齐。

如嵌套列表的*是和上面的"列"字是对齐的

复制代码
* 列表
  * 嵌套列表1
    * 嵌套列表2
  • 列表
    • 嵌套列表1
      • 嵌套列表2

数字列表

也可以创建数字列表,输入 数字. 空格 列表项

如:

复制代码
1. 列表项1
2. 列表项2
   * 嵌套列表项
  1. 列表项1
  2. 列表项2
    • 嵌套列表项

任务列表

使用 - [x] 任务描述 创建一个完成项,使用 - [ ] 任务描述 创建一个未完成项。

复制代码
- [x] 已完成
- [ ] 未完成
- [ ] https://github.com/TianXiaTech/BlurWindow/issues/2

使用emoji

输入 :emoji代码: 就可以插入emoji

如:

复制代码
:+1::+1:

👍👍

添加脚注

输入 [^脚注名称][^脚注名称]:说明 创建一个脚注

复制代码
测试脚注[^1]

[^1]:脚注说明

实际效果

测试脚注[1]

注释

输入 "<!--需要注释的内容-->"

忽略Markdown格式

在Markdown标记字符输入 \ 即可

如:

复制代码
# 一级标题
\# 一级标题

一级标题

一级标题


  1. 脚注说明 ↩︎
相关推荐
八股文领域大手子17 分钟前
如何给GitHub项目提PR(踩坑记录
大数据·elasticsearch·github
泯泷1 小时前
探索DeepWiki:开发者的代码知识库利器
github·openai·ai编程
福尔摩东2 小时前
从零到精通:2025年最全大模型学习资源
人工智能·github
Gladiator5753 小时前
博客记录-day153-力扣
github
大鹏dapeng3 小时前
使用gonectr操作gone项目,包括:创建项目、安装依赖、生成代码、编译和运行
后端·go·github
梓羽玩Python5 小时前
开源AI代理爆火!Suna:3天内新增5.5K+标星,自然对话驱动的自动化神器!
人工智能·python·github
余渔鱼11237 小时前
ASP.NET CORE部署IIS的三种方式
后端·github·asp.net
可了~7 小时前
Java——令牌技术
github
清风徐来QCQ7 小时前
git和github的使用指南
git·github
喵叔哟8 小时前
16.【.NET 8 实战--孢子记账--从单体到微服务--转向微服务】--微服务基础工具与技术--Github Action
微服务·github·.net