Markdown 是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档,然后转换成格式丰富的HTML页面。GitHub 作为全球最大的代码托管平台之一,提供了丰富的Markdown编辑功能,使得用户可以轻松地在仓库中创建和编辑文档。以下是使用Markdown在GitHub上排版代码和文档的几个步骤和技巧:
1. 基础语法
1.1 标题
使用 # 号创建标题,# 的数量决定了标题的级别。
# 一级标题
## 二级标题
### 三级标题
1.2 段落
直接输入文本即可创建段落,Markdown 会自动将两个换行符之间的文本转换为段落。
1.3 强调
使用 * 或 ** 来加粗或斜体文本。
*斜体*
**加粗**
1.4 列表
使用 -、* 或 + 创建无序列表,使用数字和句点创建有序列表。
- 无序列表项1
- 无序列表项2
- 子列表项1
- 子列表项2
1. 有序列表项1
2. 有序列表项2
1.5 代码
使用反引号 ` 将代码块包裹起来,并指定语言,以便 GitHub 高亮显示。
```python
def hello_world():
print("Hello, World!")
## 2. 代码块
### 2.1 语法高亮
在代码块的第一行指定编程语言,GitHub 会自动为该语言添加语法高亮。
```markdown
```python
def hello_world():
print("Hello, World!")
### 2.2 代码折叠
为了提高文档的可读性,可以将代码块设置为可折叠,只显示标题。
```markdown
```python
{:.fold}
def hello_world():
print("Hello, World!")
## 3. 表格
使用 `|` 和 `-` 创建表格,第一行用于定义列标题,第二行用于分隔标题和内容。
```markdown
| 表头1 | 表头2 | 表头3 |
| --- | --- | --- |
| 内容1 | 内容2 | 内容3 |
4. 图片
使用  在文档中插入图片。

5. 链接
使用 [链接文本](链接地址) 创建链接。
[访问GitHub](https://github.com)
6. 高级技巧
6.1 数学公式
使用 LaTeX 语法插入数学公式。
$$
E = mc^2
$$
6.2 表情符号
使用 : 符号插入表情符号。
:smile:
总结
使用Markdown在GitHub上排版代码和文档非常简单,只需掌握一些基本语法和技巧即可。通过灵活运用这些工具,您可以轻松地创建具有良好格式和可读性的文档,让您的项目更具吸引力。
