跳至主要内容

关于在 GitHub 上的撰写与格式化

GitHub 将一种用于格式化文本的语法 GitHub Flavored Markdown 与一些独特的写作功能结合在一起。

谁可以使用此功能?

Markdown 可在 GitHub 网页界面中使用。

Markdown 是一种易读、易写的语言,用于格式化纯文本。

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

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

文本格式化工具栏

GitHub 上的每个评论框都包含一个文本格式化工具栏,让您无需学习 Markdown 语法即可对文本进行格式化。除了粗体、斜体、标题、链接和列表等 Markdown 格式外,工具栏还包括 GitHub 特有的功能,例如 @ 提及、任务列表以及指向议题和拉取请求的链接。

在编辑器中启用等宽字体

您可以在 GitHub 的每个评论框中启用等宽字体。等宽(或称 monospaced)字体的每个字符占据相同的水平空间。这可以让编辑表格和代码片段等高级 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. 在右上角的任何页面上,点击您的个人资料图片,然后点击 设置.
  2. 在左侧边栏,点击 外观
  3. 在“Markdown 编辑器字体首选项”下,选择 在编辑 Markdown 时使用等宽(monospace)字体
    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.

延伸阅读

© . This site is unofficial and not affiliated with GitHub, Inc.