Skip to main content

이 버전의 GitHub Enterprise Server는 다음 날짜에 중단됩니다. 2024-08-29. 중요한 보안 문제에 대해서도 패치 릴리스가 이루어지지 않습니다. 더 뛰어난 성능, 향상된 보안, 새로운 기능을 위해 최신 버전의 GitHub Enterprise Server로 업그레이드합니다. 업그레이드에 대한 도움말은 GitHub Enterprise 지원에 문의하세요.

문서에서 도구 전환기 만들기

도구 전환기를 사용하여 특정 도구를 사용하여 작업을 완료하는 방법을 보여 줄 수 있습니다.

도구 전환기 정보

일부 문서에서는, 다른 도구에 맞게 조정된 콘텐츠(GitHub UI, GitHub CLI, GitHub Desktop, cURL, Codespaces, VS Code, GraphQL API 등)를 작성합니다. 도구 전환기를 사용하면 도구에 다른 개념적 또는 절차적 정보가 있을 수 있으므로 도구와 관련된 콘텐츠만 볼 수 있는 도구를 선택할 수 있습니다.

문서의 도구 전환기 스크린샷. 도구 전환기는 진한 주황색 윤곽선으로 표시됩니다.

해당 문서를 읽을 때 두 가지 방법으로 도구 전환기를 사용할 수 있습니다.

  • 탐색하기 - 다양한 도구로 완료할 수 있는 작업을 탐색하면, 도구 전환기가 작업을 수행할 수 있는 여러 가지 방법이 있음을 사용자에게 알립니다. 예를 들어 GitHub UI 대신 GitHub CLI 또는 GitHub Desktop을(를) 사용하세요.

  • 핵심 이해하기 - 다른 사용자가 작업을 수행하는 방법을 알고 있으며 추가 옵션을 볼 필요가 없는 경우, 도구 전환기는 관련성이 낮은 콘텐츠를 제거하므로 필요한 내용을 정확하게 찾을 수 있습니다.

도구 태그 사용하기

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에 사용된 첫 번째 도구 태그가 문서에 선택됩니다. 문서의 프런트 매터에서 defaultTool: 속성을 지정하여 문서에 대한 다른 기본 도구를 정의할 수 있습니다. 자세한 내용은 콘텐츠 추가 정보를 참조하세요.

링크 끝에 ?tool=TOOLNAME을(를) 추가하여 선택한 특정 도구를 문서에 연결할 수도 있습니다. 자세한 내용은 "스타일 가이드"을(를) 참조하세요.

아티클에 최대 8개의 다른 도구만 포함됩니다. 더 많은 도구를 포함하면 도구 전환기 탭이 문서의 목차로 오버플로되어 사용자가 도구 전환기 또는 목차를 사용할 수 없게 됩니다. 문서에 여덟 개의 개별 도구를 포함해야 할 가능성은 거의 없습니다. 일반적으로 문서에서 가능한 한 적은 수의 개별 도구를 사용하도록 계획하세요.

도구 태그를 사용하는 경우

사용자가 작업을 수행하는 데 도움이 되는 도구 관련 정보가 문서에 있어야 하는 경우에만 도구 태그를 사용합니다.

다른 언어로 예시를 표시하는 용도로만 도구 전환기를 사용하지 마세요. 문서에 설명된 작업 또는 개념이 사용자가 사용한 도구를 바탕으로 변화하는 경우에만 도구 전환기를 사용하세요.

새 도구 추가하기

GitHub Docs은(는) GitHub 제품에 대한 도구 태그, GitHub에서 개발한 도구, GitHub과(와) 공동으로 개발한 제3자 확장을 문서화하고 유지합니다.

새 도구는 특정 사용자에게 필요한 항목을 정확하게 문서화할 수 있는 유일한 방법인 경우에만 추가됩니다. 작성자가 새 도구를 추가하는 것이 무언가를 정확하게 문서화하는 유일한 방법이라고 판단하는 경우 콘텐츠 계획 단계에서 새 도구를 제안해야 합니다. 콘텐츠 디자인 플랜을 검토하는 사람은 새 도구를 추가하지 않고 설명서 필요를 해결할 수 있는 다른 방법이 있는지 고려해야 합니다. 새 도구가 정확한 설명서를 만드는 유일한 방법인 경우 새 도구를 추가해야 합니다. 새 도구를 추가하지 않는 대체 콘텐츠 해법이 있는 경우 해당 옵션을 사용해야 합니다.

새 도구를 추가하려면 파일의 allTools 개체에 lib/all-tools.js 파일을 키-값 쌍으로 추가하세요. 키는 문서의 도구를 참조하는 데 사용하는 태그이며, 값은 도구 최상단에 있는 도구 선택기에서 도구를 식별하는 방법입니다. 예들 들어 vscode: 'Visual Studio Code'입니다.

새 도구를 사전 순으로 추가합니다.