Markdown 是一种轻量级的标记语言,它允许人们使用易读易写的纯文本格式编写文档,然后转换成有效的XHTML(或者HTML)文档。GitHub 支持 Markdown 语法,使其成为编写和分享代码、文档以及项目文档的理想平台。以下是一篇关于如何在 GitHub 中使用 Markdown 编辑的示例文章。

参考链接

GitHub基本撰写和格式语法

1. 标题

在 Markdown 中,你可以通过在文本前加上不同数量的 # 符号来创建不同级别的标题。

# 这是一级标题

## 这是二级标题

### 这是三级标题

#### 这是四级标题

##### 这是五级标题

###### 这是六级标题

2. 强调

你可以通过星号 * 或下划线 _ 来对文本进行强调。

*这是斜体文本*
_这也是斜体文本_

**这是粗体文本**
__这也是粗体文本__

**_这是粗体加斜体文本_**

3. 列表

无序列表使用星号 *、加号 + 或减号 - 来创建。

* 项目1
* 项目2
* 项目3

有序列表则使用数字后跟一个点来创建。

1. 第一项
2. 第二项
3. 第三项

4. 链接和图片

在 Markdown 中添加链接和图片的语法非常相似,区别在于链接使用 <> 包裹 URL,而图片使用 ! 开头。

[这是一个链接](http://www.example.com)

![这是一个图片](http://www.example.com/image.jpg)

5. 引用

引用文本是通过在文本前加上 > 符号来创建的。

> 这是一个引用文本。

6. 代码

对于行内代码,你可以用反引号 ` 包裹代码。

这是一个 `行内代码` 示例。

对于代码块,你可以使用三个反引号 ``` 包裹代码。

这是一个代码块。

7. 表格

创建表格需要使用 | 来分隔列,使用 - 来分隔表头和表内容。

| 表头1 | 表头2 | 表头3 |
|-------|-------|-------|
| 单元格1 | 单元格2 | 单元格3 |
| 单元格4 | 单元格5 | 单元格6 |

8. 任务列表

GitHub 支持 Markdown 任务列表,通过 - [ ]- [x] 来标记未完成和已完成的任务。

- [x] 完成的任务
- [ ] 未完成的任务

结语

Markdown 是一个强大的工具,它使得在 GitHub 上编写和分享文档变得简单而高效。通过上述示例,你可以开始在 GitHub 上使用 Markdown 来创建和管理你的文档和项目资料。记住,Markdown 的语法简洁而直观,一旦你掌握了基本的语法,你将能够快速地编写出整洁、易读的文档。

💖 转载请注明出处,谢谢 💖