关于GitHub代码格式化方法及底层逻辑的咨询
Markdown格式化指南
以下是各类内容的Markdown格式化规则及示例:
标题:使用数字符号(
#),数量对应标题级别,1个#为一级标题,2个为二级标题,最多支持6级。示例:# 一级标题 ## 二级标题 ### 三级标题列表项:以短横线(
-)开头,若需要嵌套列表,可在子项前添加缩进。示例:- 主列表项1
- 子列表项1-1
- 子列表项1-2
- 主列表项2
- 主列表项1
文本强调:用星号(
*)包裹文本,单星号对应斜体效果,双星号对应粗体效果。示例:- 斜体文本:这是斜体
- 粗体文本:这是粗体
- 粗斜体文本:这是粗斜体
代码或命令:单行内容用单个反引号(
`)包裹,多行代码块用三个连续反引号(```)包裹,还可指定代码语言实现语法高亮。示例:- 单行代码:
npm install - 多行代码块:
function greet(name) { return `Hello, ${name}!`; }
- 单行代码:
引用文本:用大于号(
>)开头,多级引用可叠加多个>。示例:这是基础引用文本
这是嵌套的二级引用
这是更深层次的三级引用
链接:将链接显示文本放在方括号(
[])内,紧跟括号包裹的目标URL。示例:
Markdown官方文档图片:将图片的替代文本放在方括号(
[])内,紧跟括号包裹的图片URL。示例:
示例风景图
相关产品推荐
相关产品推荐

