� �题
要创建� �题，请在� �题文本前添� 一至六个 # 符号。 您使用的 # 数量将决定� �题的大小。
# 最大� �题
## 第二大� �题
###### 最小� �题
When you use two or more headings, GitHub automatically generates a table of contents which you can access by clicking within the file header. Each heading title is listed in the table of contents and you can click a title to navigate to the selected section.
� �式文本
您可以在评论字段和 .md 文件中以粗体、斜体或� 除线的文字表示强调。
| � �式 | 语法 | 键盘快捷键 | 示例 | 输出 |
|---|---|---|---|---|
| 粗体 | ** ** 或 __ __ | Command+B (Mac) or Ctrl+B (Windows/Linux) | **这是粗体文本** | 这是粗体文本 |
| 斜体 | * * 或 _ _ | Command+I (Mac) or Ctrl+I (Windows/Linux) | *这是斜体文本* | 这是斜体文本 |
| � 除线 | ~~ ~~ | ~~这是错误文本~~ | ||
| 粗体和嵌入的斜体 | ** ** 和 _ _ | **此文本 _非常_ 重要** | 此文本非常重要 | |
| 全部粗体和斜体 | *** *** | ***所有这些文本都很重要*** | 所有这些文本都是斜体 |
引用文本
You can quote text with a >.
Text that is not a quote
> Text that is a quote
Tip: When viewing a conversation, you can automatically quote text in a comment by highlighting the text, then typing R. 您可以单击 和 Quote reply（引用回复）引用整个评论。 有关键盘快捷键的更多信息，请参阅“键盘快捷键”。
引用代� �
使用单反引号可� �注句子中的代� �或命令。 The text within the backticks will not be formatted.
使用 `git status` 列出尚未提交的所有新文件或已修改文件。
要将代� �或文本� �式化为各自的不同块，请使用三反引号。
一些基本的 Git 命令为： ``` git status git add git commit ```
更多信息请参阅“创建和突出显示代� �块”。
链接
通过将链接文本包含在方括号 [ ] 内，然后将 URL 包含在括号 ( ) 内，可创建内联链接。
本站点是使用 [GitHub Pages](https://pages.github.com/) 构建的。
提示：当评论中写入了有效 URL 时，GitHub Enterprise Server 会自动创建链接。 更多信息请参阅“自动链接的引用和 URL”。
� 节链接
您可以直接链接到渲染文件中的某个部分，方法是将� � �悬停在该部分� �题上以显示链接：
相对链接
您可以在渲染的文件中定义相对链接和图像路径，以帮助读者导航到仓库中的其他文件。
相对链接是相对于当前文件的链接。 例如，如果在仓库� �目录下有一个自述文件，而在 docs/CONTRIBUTING.md 中有另一个文件，则自述文件中的 CONTRIBUTING.md 的相关链接如下所示：
[此项目的参与指南](docs/CONTRIBUTING.md)
GitHub Enterprise Server 将� �据您当前使用的分支自动转换相对链接或图像路径，从而使链接或路径始终有效。 您可以使用所有相对链接操作符，如 ./ 和 ../。
相对链接更便于用户克隆仓库。 绝对链接可能� 法用于仓库的克隆 - 建议使用相对链接引用仓库中的其他文件。
图像
You can display an image by adding ! and wrapping the alt text in [ ]. 然后将图像链接包装在括号 () 中。
GitHub Enterprise Server 支持将图像嵌入到您的议题、拉取请求、评论和 .md 文件中。 您可以从仓库显示图像、添� 在线图像链接或上� 图像。 更多信息请参阅“上� 资产”。
提示：想要显示仓库中的图像时，应该使用相对链接而不是绝对链接。
下面是一些使用相对链接显示图像的示例。
| 上下文 | 相对链接 |
|---|---|
在同一个分支上的 .md 文件中 | /assets/images/electrocat.png |
在另一个分支的 .md 文件中 | /../main/assets/images/electrocat.png |
| 在仓库的议题、拉取请求和评论中 | ../blob/main/assets/images/electrocat.png |
在另一个仓库的 .md 文件中 | /../../../../github/docs/blob/main/assets/images/electrocat.png |
| 在另一个仓库的议题、拉取请求和评论中 | ../../../github/docs/blob/main/assets/images/electrocat.png?raw=true |
注意：上表中的最后两个相对链接只有在查看者至少能够读取包含这些图像的私有仓库时，才可用于私有仓库中的图像。
更多信息请参阅“相对链接”。
列表
通过在一行或多行文本前面添� - 或 * 可创建� 序列表。
- George Washington
- John Adams
- Thomas Jefferson
要对列表排序，请在每行前面添� 一个编号。
1. James Madison
2. James Monroe
3. John Quincy Adams
嵌套列表
通过在一个列表项下面缩进一个或多个其他列表项，可创建嵌套列表。
要通过 GitHub Enterprise Server 上的 web 编辑器或使用等宽字体的文本编辑器（例如 Atom）创建嵌套列表，您可以直观地对齐列表。 在嵌套列表项的前面键入空� �字符，直至列表� �记字符（- 或 *）位于其上方条目中第一个文本字符的正下方。
1. 第一个列表项
- 第一个嵌套列表项
- 第二个嵌套列表项
要在 GitHub Enterprise Server 上的评论编辑器中创建嵌套列表（不使用等宽字体），您可以查看嵌套列表正上方的列表项，并计算该条目内容前面的字符数量。 然后在嵌套列表项的前面键入该数量的空� �字符。
在此例中，您可以通过缩进嵌套列表项至少五个空� �，在列表项 100. 第一个列表项的下面添� 一个嵌套列表项，� 为在第一个列表项的前面有五个字符 (100.) 。
100. 第一个列表项
- 第一个嵌套列表项
您可以使用相同的方法创建多层级嵌套列表。 例如，由于在第一个嵌套列表项中，嵌套列表项内容第一个嵌套列表项之前有七个字符 (␣␣␣␣␣-␣)，� 此需要将第二个嵌套列表项缩进七个空� �。
100. 第一个列表项
- 第一个嵌套列表项
- 第二个嵌套列表项
更多示例请参阅 GitHub Flavored Markdown 规范。
任务列表
To create a task list, preface list items with a hyphen and space followed by [ ]. 要将任务� �记为已完成，请使用 [x]。
- [x] #739
- [ ] https://github.com/octo-org/octo-repo/issues/740
- [ ] Add delight to the experience when all tasks are complete :tada:
If a task list item description begins with a parenthesis, you'll need to escape it with \:
- [ ] \(Optional) 打开后续议题
更多信息请参阅“关于任务列表”。
提及人员和团队
您可以在 GitHub Enterprise Server 上提及人员或团队，方法是键入 @ � 上其用户名或团队名称。 这将触发通知并提请他们注意对话。 如果您在编辑的评论中提及某人的用户名或团队名称，该用户也会收到通知。 有关通知的更多信息，请参阅"关于通知”。
@github/support 您如何看待这些更新？
当您提及父团队时，其子团队的成员也会收到通知，这简化了与多个人员团队的沟通。 更多信息请参阅“关于团队”。
键入 @ 符号将显示项目中的人员或团队列表。 列表会在您键入时进行过滤，� 此一旦找到所需人员或团队的名称，您可以使用箭头键选择它，然后按 Tab 或 Enter 键以填写名称。 提及团队时，请输入 @组织/团队名称，该团队的所有成员将收到关注对话的提醒。
自动填写结果仅限于仓库协作者和该线程上的任何其他参与者。
引用议题和拉取请求
通过键入 # 可显示仓库中建议的议题和拉取请求列表。 键入议题或拉取请求的编号或� �题以过滤列表，然后按 Tab 或 Enter 键以填写选中的结果。
更多信息请参阅“自动链接的引用和 URL”。
引用外部资源
如果自定义自动链接引用配置用于仓库，则对外部资源（如 JIRA 议题或 Zendesk 事件单）的引用将转换为缩短的链接。 要了解在您的仓库中哪些自动链接可用，请联系拥有仓库管理员权限的人。 更多信息请参阅“配置自动链接以引用外部资源”。
内容附件
有些 GitHub 应用程序 在 GitHub Enterprise Server 中提供链接到其注册域名的 URL 信息。 GitHub Enterprise Server 可渲染应用程序在正文或者议题或拉取请求的评论中的 URL 下提供的信息。
要查看内容附件，您必须拥有使用仓库中安装的内容附件 API 的 GitHub 应用程序。
内容附件不会显示在属于 markdown 链接的 URL 中。
For more information about building a GitHub 应用程序 that uses content attachments, see "Using Content Attachments."
上� 资产
您可以通过拖放、从文件浏览器中选择或粘贴来上� 图像等资产。 您可以将资产上� 到议题、拉取请求、评论和仓库中的 .md 文件。
使用表情符号
通过键入 :EMOJICODE: 可在您的写作中添� 表情符号。
@octocat :+1: 这个 PR 看起来很棒 - 可以合并了！ :shipit:
键入 : 将显示建议的表情符号列表。 列表将在您键入时进行过滤，� 此一旦找到所需表情符号，请按 Tab 或 Enter 键以填写选中的结果。
有关可用表情符号和代� �的完整列表，请查看表情符号备忘清单。
段落
通过在文本行之间留一个空白行，可创建新段落。
隐藏有评论的内容
您可以通过在 HTML 评论中� 入内容来指示 GitHub Enterprise Server 隐藏渲染的 Markdown 中的内容。
<!-- This content will not appear in the rendered Markdown -->
忽略 Markdown � �式
You can tell GitHub Enterprise Server to ignore (or escape) Markdown formatting by using \ before the Markdown character.
让我们将 \*our-new-project\* 重命名为 \*our-old-project\*。
更多信息请参阅 Daring Fireball 的“Markdown 语法”。