什么是Markdown格式?
Markdown是一种轻量级的标记语言,它允许用户使用易于阅读和编写的文本格式来创建格式化的文档。在GitHub上,Markdown被广泛用于项目文档、README文件以及Wiki页面。其语法简洁易懂,使得用户能够快速上手,且可与其他文本编辑工具兼容。
GitHub中的Markdown用途
在GitHub上,Markdown的应用主要体现在以下几个方面:
- README文件:项目的介绍和使用说明。
- Wiki页面:为项目创建更详细的文档。
- Issues和Pull Requests:在讨论中插入格式化的文本。
- 代码注释:使用Markdown语法增强代码可读性。
GitHub Markdown基本语法
标题
使用#
表示标题,#
的数量表示标题的层级:
markdown
二级标题
三级标题
文本样式
- 加粗:使用
**文本**
或__文本__
。 - 斜体:使用
*文本*
或_文本_
。 - ~~删除线~~:使用
~~文本~~
。
列表
无序列表
使用-
、*
或+
创建无序列表:
markdown
- 项目1
- 项目2
- 子项目1
- 子项目2
有序列表
使用数字加点号创建有序列表:
markdown
- 第一点
- 第二点
- 子点1
- 子点2
链接和图片
- 链接:使用
[链接文本](网址)
格式。 - 图片:使用
![替代文本](图片网址)
格式。
引用
使用>
表示引用:
markdown
这是一个引用。
代码块
使用反引号`
表示行内代码,使用三个反引号表示代码块:
markdown
代码内容
表格
使用管道符|
和横线-
来创建表格:
markdown | 列1 | 列2 | |——|——| | 数据1 | 数据2 |
GitHub Markdown高级功能
除了基本语法外,GitHub还支持一些高级功能:
- 任务列表:使用
- [ ]
表示未完成,- [x]
表示已完成。 - 脚注:使用`[
正文完