关于在 GitHub 上的写作和格式

GitHub 将一种称为 GitHub Flavored Markdown 的文本格式语法与一些独特的写作功能相结合。

本文介绍

Markdown 是一种易于阅读和编写的用于格式化纯文本的语言。

我们添加了一些自定义功能来创建 GitHub Flavored Markdown，用于在我们的网站上格式化散文和代码。

您还可以使用 @-mentions、问题和 PR 引用以及表情符号等功能在拉取请求和问题中与其他用户互动。有关更多信息，请参阅“基本写作和格式语法”。

文本格式工具栏

GitHub 上的每个评论字段都包含一个文本格式工具栏，它允许您在不学习 Markdown 语法的情况下格式化文本。除了粗体和斜体样式等 Markdown 格式以及创建标题、链接和列表之外，工具栏还包括 GitHub 特定的功能，例如 @-mentions、任务列表以及指向问题和拉取请求的链接。

在编辑器中启用等宽字体

您可以在 GitHub 上的每个评论字段中启用等宽字体。等宽字体（或单空格字体）中的每个字符都占据相同的水平空间。这可以使编辑高级 Markdown 结构（如表格和代码片段）更容易。

Screenshot of a GitHub comment showing a sample Markdown table listing two Git commands. All letters in the table are the same visual width.

  1. 在 GitHub 上任何页面的右上角，单击您的个人资料照片，然后单击 **设置**。
  2. 在左侧边栏中，单击 ** 外观**。
  3. 在“Markdown 编辑器字体首选项”下，选择 **在编辑 Markdown 时使用等宽（单空格）字体**。
    Screenshot of GitHub user settings for Markdown preference. The checkbox to use a fix-width font in Markdown is checked and outlined in dark orange.

进一步阅读