github markdown 基础语法 - 图1
github markdown 基础语法 - 图2
github markdown 基础语法 - 图3
github markdown 基础语法 - 图4

From Basic writing and formatting syntax

Create sophisticated formatting for your prose and code on GitHub with simple syntax.

标题(Headings)

需要在 # 字符后面加空格

一级标题

二级标题

最小层级标题

一级标题

二级标题

最小层级标题

样式文本(Styling text)

  • 粗体 需要设置为粗体的文字
    需要设置为粗体的文字

  • 斜体 需要设置为斜体的文字
    需要设置为斜体的文字

  • 删除线 需要设置为删除线的文字
    需要设置为删除线的文字

  • 粗体里内置斜体 粗体文字粗体里面的斜体粗体文字
    粗体文字 粗体里面的斜体 粗体文字

引用文本(Quoting text)

需要引用的文本

需要引用的文本

引入代码块(Quoting code)

符号为数字1左边的字符, 后面跟语法高亮的语言类型

  1. // 需要引入的代码块
  2. const PI = 3.1415;
// 需要引入的代码块
const PI = 3.1415;

网页链接(Links)

链接文字, 如果是加载图片![图片占位文本](图片链接)

示例链接 zuo11.com)

zuo11.com

关联链接(Relative links)

链接到项目的其它文件 JS笔记

JS笔记

无序列表(unordered list)

每个子项 以 * 或 -开头

  • list1
  • list2
  • list3

有序列表(order list)

  1. list1
  2. list2

任务列表(Task lists)

类似于checkbox,多选框效果

  • [x] 已完成的计划

  • [ ] 待完成 1

  • [ ] 待完成 2

  • [x] 已完成的计划

  • 待完成 1
  • 待完成 2

提及某个人或team(@某个人或team)

对方会收到对应的通知

@github/support what do you think about these updates?

@zuoxiaobai what do you think about these updates?

引用一个issue或pull request

具体示例

表情

:表情对应的字符:
truck +1 fire

github markdown 基础语法 - 图5 github markdown 基础语法 - 图6 github markdown 基础语法 - 图7

查看所有支持的表情: emoji-cheat-sheet.com.

忽略markdown格式

在前面加 \

表格

第一表头 | 第二表头
---| ---
第一单元格内容 | 第二单元格内容
第一列内容 | 第二列内容
第一表头 第二表头
第一单元格内容 第二单元格内容
第一列内容 第二列内容