Skip to main content

此版本的 GitHub Enterprise Server 已于以下日期停止服务 2026-04-09. 即使针对重大安全问题,也不会发布补丁。 为了获得更好的性能、更高的安全性和新功能,请升级到最新版本的 GitHub Enterprise。 如需升级帮助,请联系 GitHub Enterprise 支持

引用内容类型

参考内容提供了在用户主动使用某项功能时所需的详细信息。

可查阅参考资料以获取特定信息。 这是你可以快速查看的信息,这意味着对句子和段落的强调减少了。

参考信息可能最适合以表格、列表或其他结构化格式呈现。 我们可能将引用理解为包括自动生成的管道内容和其他可能自动化的内容。

参考内容出现在参考文章中,并在其他文章的参考部分中出现。

  • 某些主要主题可能需要自己的参考文章,尤其是在存在大量参考内容时,例如搜索语法或 YAML 语法。GitHub Actions
  • 对于内容量较小或更具体的信息(如功能支持的语言或硬件要求列表),请使用过程或概念文章上下文中的参考部分。

如何编写引用内容

有关参考内容模板,请参阅 模板

  • 编写句子或整个概念部分来介绍引用内容。
  • 清楚地、一致地呈现实际引用内容。
  • 对于具有要说明的单个元素的主题,请使用列表。
  • 对于具有要说明的多个元素的主题,请使用表。
  • 对于较长的参考内容(例如工作流的 YAML 语法),请一致地使用标头。

参考内容的标题

  • 参考文章或参考部分的标头清楚地描述了部分的内容,通常以名词开头。
  • 标题包含可供新手访问的足够信息,并全面描述每个部分的内容。
  • 标题应避免堆积名词 - 使用介词分解长串名词。
  • 短标题应该是一个单词或名词短语。 示例:“AI 模型”。

参考内容示例