跳至主要内容

在文章中创建工具切换器

您可以使用工具切换器展示如何使用特定工具完成任务。

关于工具切换器

在某些文章中,我们编写针对不同工具(GitHub UI、GitHub CLI、GitHub Desktop、cURL、Codespaces、VS Code、GraphQL API 等)的专属内容。工具切换器允许读者选择工具,只查看与该工具相关的内容,因为不同工具可能具有不同的概念或操作信息。

Screenshot of tool switchers in an article. The tool switchers are indicated with a dark orange outline.

在阅读文档时,读者可以通过两种方式使用工具切换器。

  • 探索 - 对于可以使用不同工具完成的任务,工具切换器向读者表明该任务有多种完成方式。例如,使用 GitHub CLI 或 GitHub Desktop,而不是 GitHub UI。

  • 直达要点 - 当用户已经知道自己想使用哪种工具完成任务且不需要看到其他选项时,工具切换器会移除不太相关的内容,让他们精准找到所需信息。

使用工具标签

您可以在文章中使用 Markdown 的工具标签来添加工具切换器。工具标签是 Liquid 标记,用于包裹您希望在特定工具切换器标签页中显示的内容。

例如,下面的代码块展示了针对三种不同工具的内容。

{% vscode %}
This content is specific to Visual Studio Code.
{% endvscode %}

{% visualstudio %}
This content is specific to Visual Studio.
{% endvisualstudio %}

{% jetbrains %}
This content is specific to JetBrains IDEs.
{% endjetbrains %}

默认情况下,Markdown 中使用的第一个工具标签会被选为文章的默认工具。您可以在文章的 frontmatter 中通过指定 defaultTool: 属性来定义其他默认工具。更多信息,请参阅 content README

您也可以在链接末尾添加 ?tool=TOOLNAME,以直接打开特定工具选中的文章。更多信息,请参阅 Style guide

每篇文章最多只能包含八种不同的工具。包含更多工具会导致工具切换器标签与文章目录冲突,使读者无法正常使用工具切换器或目录。实际上,您几乎不需要在一篇文章中包含八种工具。一般而言,请尽量在文章中使用尽可能少的工具。

何时使用工具标签

我们仅在文章必须包含特定工具信息以帮助读者完成任务时才使用工具标签。

不要仅仅为了展示不同语言的示例而使用工具切换器。只有当文章中描述的任务或概念会因使用的工具不同而变化时才使用工具切换器。

添加新工具

GitHub Docs 为 GitHub 产品、GitHub 开发的工具以及与 GitHub 合作开发的部分第三方扩展维护工具标签。

仅在新工具是唯一能够准确满足特定用户需求的文档需求时才会添加。若撰稿人认定添加新工具是唯一能准确记录某内容的方式,则需在内容设计计划中提出该新工具。审阅内容设计计划的人员应考虑是否有其他方式在不新增工具的情况下满足文档需求。若新工具确实是唯一可实现准确文档的手段,则应添加该工具;若存在无需新增工具的替代内容方案,则应采用该方案。

要添加新工具,请在 lib/all-tools.ts 文件的 allTools 对象中添加键值对。键是您在文章中引用该工具时使用的标签,值是该工具在文章顶部工具选择器中显示的名称。例如,vscode: 'Visual Studio Code'

按照字母顺序添加新工具。

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