Skip to main content

关于在 GitHub 上编写和设置格式

GitHub 结合了用于格式化文字的语法,称为 GitHub Flavored Markdown,具有一些独特的写作功能。

Markdown 是一种易于读取和编写的语法,用于设置纯文本格式。

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

还可以使用 @-mentions、问题和 PR 参考和表情包等功能在拉取请求和问题中与其他用户互动。 有关详细信息,请参阅“基本撰写和格式语法”。

文本格式工具栏

GitHub 上的每个评论字段都包含文本格式工具栏,无需了解 Markdown 语法即可设置文本的格式。 除了 Markdown 格式设置(如粗体和斜体样式)和创建标题、链接及列表等之外,工具栏还包括 GitHub 特定的功能,如 @-mentions、任务列表和指向问题和拉取请求的链接。

在编辑器中启用定宽字体

可以在 GitHub 的每个注释字段中启用定宽字体。 定宽(也称固定宽度)字体中的每个字符占据相同的水平空间。 这可以更容易地编辑高级 Markdown 结构,例如表和代码片段。

GitHub 注释的屏幕截图,其中显示了列出两个 Git 命令的示例 Markdown 表。 表中的所有字母都具有相同的视觉宽度。

  1. 在任何页面的右上角,单击个人资料照片,然后单击“设置”。

    Screenshot of a user's account menu on GitHub. The menu item "Settings" is outlined in dark orange.

  2. 在左侧边栏中,单击“ 外观”。

  3. 在“Markdown 编辑器字体首选项”下,选择“编辑 Markdown 时使用定宽(固定宽度)字体”。 GitHub 用户设置中 Markdown 首选项的屏幕截图。 选中了在 Markdown 中使用定宽字体的复选框,并用深橙色框出。

延伸阅读