계정 및 API 키

keys 키는 Google Analytics나 검색 도구와 같은 서비스 통합에 사용되는 계정 식별자를 지정하는 이름-값 쌍의 맵을 받습니다.

keys 키

keys 키는 선택사항입니다. 플레이북에서 site 키 아래에 keys 키를 정의합니다. keys는 계정 식별자를 지정하는 이름-값 쌍(일명 하위 키)의 목록을 받습니다.

Example 1. antora-playbook.yml

site:
  title: Site Title
  url: https://example.org
  keys:
    name-of-account-key: 'identifier'
    google_analytics: 'XX-123456'

이러한 키의 값은 UI 모델의 site.keys 속성을 통해 UI 템플릿에서 접근할 수 있습니다. UI 모델에 할당될 때, 이름은 카멜케이스로 변환됩니다(이름의 단어가 하이픈이나 밑줄로 구분되어 있는지 여부와 관계없이). 예를 들어, 위의 예시에서 정의된 키에 각각 site.keys.nameOfAccountKey와 site.keys.googleAnalytics로 접근할 수 있습니다.

사이트 키는 CLI를 통해서도 구성할 수 있습니다.

Google Analytics 계정 추가하기

google_analytics 키는 사이트에 Google Analytics 계정을 할당합니다. 이 옵션을 설정하면 기본 UI를 사용할 때 Google Analytics / Tag Manager 임베드 코드가 자동으로 활성화됩니다.

Example 2. antora-playbook.yml

site:
  title: Demo Docs Site
  url: https://demo.antora.org
  keys:
    google_analytics: 'XX-123456'

YAML 파서에 의해 값이 변형되는 것을 방지하기 위해 작은따옴표(')로 값을 감싸는 것을 권장합니다. google_analytics 키는 CLI를 통해서도 구성할 수 있으며, GOOGLE_ANALYTICS_KEY 환경 변수를 사용하여 설정할 수도 있습니다.