Skip to main content

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

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

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

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

您也可以在拉取请求和议题中使用 @提及议题和 PR 参考表情符号等功能与其他用户交互。

文本格式工具栏

GitHub 上的每个评论字段都包含文本格式工具栏,用于格式化文本,而无需了解 Markdown 语法。 除了 Markdown 格式(如粗体和斜体样式)和创建标题、链接及列表等之外,工具栏还包括 GitHub 特定的功能,如 @提及、任务列表以及链接到议题和拉取请求。

在编辑器中启用固定宽度字体

您可以在 GitHub 的每个注释字段中启用固定宽度的字体。 固定宽度或等宽字体中的每个字符都占用相同的水平空间,这样可以更轻松地编辑高级 Markdown 结构,如表格和代码段。

显示启用了固定宽度字体的 GitHub 注释字段的屏幕截图

  1. 在任何页面的右上角,单击您的个人资料照片,然后单击 Settings(设置)

    用户栏中的 Settings 图标

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

  3. 在“Markdown editor font preference(Markdown 编辑器字体首选项)”下,选择 Use a fixed-width (monospace) font when editing Markdown(编辑 Markdown 时使用固定宽度(等宽)字体)显示启用了固定宽度字体的 GitHub 注释字段的屏幕截图

延伸阅读