설명서 버전 관리하기

GitHub Docs에서는, GitHub의 주요 제품 제공에 걸쳐 UI와 기능의 차이를 반영한 설명서의 버전을 제공합니다. 기여자는 버전 관리 구문을 사용하여 콘텐츠 범위를 특정 제품 제공 사항으로 지정할 수 있습니다.

버전 관리 구문은 독자가 사용하고 있는 제품에 적용되는 설명서의 버전을 수동으로 선택할 수 있게 합니다. GitHub Docs의 URL에는 버전 관리 정보도 포함될 수 있으므로 GitHub Docs의 한 버전에서 다른 버전으로 연결하여 독자가 사용 중인 제품에 대한 문서로 바로 이동할 수 있습니다.

버전 관리 방법 및 위치

GitHub Docs의 콘텐츠 버전 관리는 반복을 피하고 문장을 DRY하게 유지하기 위해 단일 소스를 사용합니다. 문서의 경우 YAML 메타데이터를 사용하여 개별 Markdown 파일에 버전 관리를 적용한 다음, 파일의 산문 내에서 조건문을 사용하여 독자가 선택한 버전에 따라 표시할 텍스트를 사이트에 지시합니다. 단일 소싱은 각 버전의 콘텐츠를 반영한 별도 파일을 만드는 것과 대조됩니다.

GitHub Docs에 대한 버전 관리 구문에는 두 가지 유형이 있습니다.

YAML: content/의 Markdown 파일 내의 YAML 프런트 매터에서 가장 자주 사용되지만 data/의 여러 형식의 YAML 파일에서도 사용됩니다. 전체 콘텐츠에 대해 버전 관리를 표시하세요.
```
versions:
  PRODUCT: 'VERSIONS'
  PRODUCT: 'VERSIONS'
  ...
```
다음 예시에서는 Free, Pro 및 Team, GitHub Enterprise Server의 모든 버전에 대해 버전이 지정된 콘텐츠를 보여 줍니다.
```
versions:
  fpt: *
  ghes: *
```
Liquid: content/과(와) data/reusables/의 Markdown 파일,data/variables/의 YAML 파일 내 변수 문자열 또는 data/glossaries/external.yml내의 문자열에 사용됩니다. 독자가 YAML 프런트 매터로 정의된 여러 버전이 있는 콘텐츠의 버전을 선택할 때 어떤 텍스트를 표시할지 표시하세요.
- 제품 기반의 버전 관리:
```
{% ifversion SHORT-PRODUCT-NAME %} ... {% endif %}
```
- 기능 기반의 버전 관리:
```
{% ifversion FEATURE-NAME %} ... {% endif %}
```

설명서 버전 관리하기

이 기사에서

버전 관리 방법 및 위치