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

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

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

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

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

文本格式工具栏

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

Enabling fixed-width fonts in the editor

You can enable a fixed-width font in every comment field on GitHub. Each character in a fixed-width, or monospace, font occupies the same horizontal space which can make it easier to edit advanced Markdown structures such as tables and code snippets.

Screenshot showing the GitHub comment field with fixed-width fonts enabled

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

  2. 在用户设置侧边栏中,单击 Appearance(外观)

    用户设置侧边栏中的"外观"选项卡

  3. Under "Markdown editor font preference", select Use a fixed-width (monospace) font when editing Markdown. Screenshot showing the GitHub comment field with fixed width fonts enabled

延伸阅读

此文档对您有帮助吗?

隐私政策

帮助我们创建出色的文档!

所有 GitHub 文档都是开源的。看到错误或不清楚的内容了吗?提交拉取请求。

做出贡献

或者, 了解如何参与。