GitHub使用的是基于CommonMark的Markdown渲染器,它支持CommonMark规范中的大部分语法,并且还提供了一些额外的功能和扩展。
在GitHub中,.md
文件(或其他扩展名为.markdown
)会被识别为Markdown格式的文件。当你在GitHub上打开一个Markdown文件时,它将会被渲染为HTML,以便在浏览器中显示。
GitHub中的Markdown文件可以使用常见的Markdown语法来标记文本的结构和格式。以下是一些常用的标记示例:
-
标题:使用
#
符号表示标题级别,例如# Heading 1
表示一级标题,## Heading 2
表示二级标题,依此类推。 -
列表:使用
-
或*
符号表示无序列表,使用数字和.
表示有序列表。 -
强调和加粗:使用
*
或_
符号将文本包裹起来表示强调,使用双重*
或__
包裹表示加粗。 -
链接:使用
[显示文本](链接地址)
的形式创建链接,例如[Google](https://www.google.com)
。 -
图片:使用

的形式插入图片,例如
。 -
代码块:使用三个反引号(```)包裹代码块,可以指定代码的语言,例如:
```jsonc
python3 blog.py
``` -
任务列表(Task Lists):GitHub允许在列表中使用复选框来创建任务列表。在列表中的每一行的开头使用
- [ ]
表示未完成的任务,使用- [x]
表示已完成的任务。 -
表格(Tables):GitHub支持创建简单的表格。表格由行和列组成,使用
|
符号来分隔每个单元格。第一行通常是表头,使用连字符-
和冒号:
来定义列的对齐方式。 -
引用块(Blockquotes):GitHub支持使用大于号
>
创建引用块。引用块通常用于引用他人的评论、引用外部文档或提供额外的上下文。 -
删除线(Strikethrough):GitHub支持使用双波浪线
~~
包裹文本来添加删除线效果。删除线通常用于显示已过时或不再有效的内容。
GitHub还支持许多其他的Markdown扩展,你可以在GitHub的官方文档中找到更详细的Markdown语法和支持的功能列表。
基本撰写和格式语法 - GitHub 文档
当你在GitHub上编辑Markdown文件时,可以实时预览渲染后的效果。这样你就可以在编辑器中看到Markdown文本的外观,并在保存后将其渲染为HTML进行展示。