README.md 完全指南:Markdown 语法+实例
目录
【实时预览工具】
【标题格式】
【换行】
【列表格式】
【勾选框】
【强调】
【插入代码】
【插入图片】
【插入超链接】
【插入表格】
【分割线】
【块引用】
【目录】
【多级树结构引导菜单】
【更多操作】
在 GitHub、Gitee 等代码托管平台中,README 文件均采用 Markdown 语言编写。掌握 Markdown 语法并撰写规范的 README.md,已成为开发者不可或缺的技能。
Markdown 是一种轻量级标记语言,通过直观的符号(如 #
、*
、>
等)即可实现文本格式化。其语法简洁易读,支持快速转换为 HTML 等多种格式,兼顾了书写效率与跨平台兼容性。
【实时预览工具】
工欲善其事,必先利其器。
这里推荐使用 StackEdit 进行 Markdown 内容编辑,优点是可以左侧编辑,右侧实时预览
英文版:StackEdit
中文版:StackEdit中文版
【标题格式】
# 标题内容 ‘#’号的数量确定了是几级标题。重点注意 #号后一定要有空格
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
【换行】
直接回车不能换行,可通过以下三种方式实现换行:
方法1:在行末尾添加<br>
方法2:在行末尾添加两个空格。(推荐)
方法3:在两行之间插入一个空行。
【列表格式】
(1)无序列表
语法格式:'-'、'*'、'+'等符号均可生成无序列表。
-[空格]列表内容
#形式一
- 列表1
- 列表2
#形式二
* 列表1
* 列表2
#形式三
+ 列表1
+ 列表2
(2) 有序列表
语法格式: 数字.[空格]列表内容
1. 列表1
2. 列表2
3. 列表3
【勾选框】
语法格式:
- [x] 内容1
- [ ] 内容2
【强调】
语法格式:使用*号或者_号生成
*斜体* 或 _斜体_
**粗体** 或 __粗体__
***粗斜体*** 或 ___粗斜体___
~~删除线~~
<u>下划线</u>
==高亮文本==
【插入代码】
单行输入
语法格式: `代码` 【注意:该符号按键位于键盘上Tab上方】
例:输出`hello world`这条语句
多行代码
语法格式:···和 编程语言(可选,选上后会有高亮显示)
```C
int main(){
return 0;
}
```
【插入图片】

【插入超链接】
[链接显示文本](超链接地址)
[百度](https://www.baidu.com)
【插入表格】
标题|标题|标题
-|-|-
内容|内容|内容
如果想让表格内容左对齐、居中或右对齐,可以在分割行添加:
左对齐
|:--|:--|
右对齐
|--:|--:|
居中
|:--:|:--:|
可以使用工具在线生成Markdown表格:https://www.tablesgenerator.com/markdown_tables
【分割线】
语法格式:
*** 或 ---
【块引用】
>[空格]内容
【目录】
1. [目录名1](#显示的文本(即目录项名称))
2. [目录名2](#锚点链接,指向文档中对应的标题部分(需与标题的ID匹配))
如:
## 目录
1. [GitHub简介](#github简介)
2. [创建GitHub账号](#创建github账号)
3. [Git基础操作](#git基础操作)
【多级树结构引导菜单】
例如:
> 一级菜单
>> 二级菜单
>>> 三级菜单
【更多操作】
使用html实现MarkDown不支持的功能,插入视频等更多操作,可以参考:更多操作
参考:
如何写好README.md文件_使用markdown插件(pycharm)撰写readme.md文件 对代码的文件结构加以说明。建议-CSDN博客
8分钟让你快速掌握Markdown_哔哩哔哩_bilibili
教你写README.md——GitHub标记语言教程_哔哩哔哩_bilibili
GitHub上README.md编写教程(基本语法)_github readme.md编写-CSDN博客