사이트 시작 페이지

플레이북의 start_page 키에 유효한 페이지의 리소스 ID를 할당하면, 사이트 방문자는 사이트 URL의 인덱스 페이지에서 시작 페이지의 URL로 리디렉션됩니다.

start_page 키

start_page 키는 선택사항입니다. 이는 플레이북의 site 키 아래에 구성됩니다.

Example 1. antora-playbook.yml

site:
  title: Site Title
  url: https://example.org
  start_page: component:module:file-coordinate-of-page.adoc

컴포넌트 버전에 속한 어떤 페이지든 사이트의 인덱스 페이지로 사용할 수 있습니다. start_page 키는 페이지의 리소스 ID를 값으로 받습니다. 리소스 ID는 반드시 컴포넌트, 모듈, 파일 좌표를 포함해야 합니다. 최신 버전 대신 특정 버전의 페이지를 사용하려면 버전 좌표를 지정할 수 있습니다. 또는 start_page를 CLI에서 할당할 수도 있습니다.

사이트에 버전이 없는 ROOT라는 이름의 컴포넌트가 있다면 (즉, name: ROOT, version: ~), 해당 컴포넌트는 사이트의 루트에 게시됩니다. 이 경우 컴포넌트 이름은 해당 페이지들의 URL에 나타나지 않습니다. 이는 버전이 없는 ROOT 컴포넌트의 ROOT 모듈에 있는 index.adoc 페이지(즉, modules/ROOT/pages/index.adoc)가 플레이북에 명시하지 않아도 암묵적으로 사이트 시작 페이지 역할을 한다는 의미입니다. 다시 말해, 사이트 시작 페이지는 사실상 ROOT::index.adoc입니다. 이 경우에 다른 사이트 시작 페이지를 지정하더라도, 사이트에 이미 시작 페이지가 있기 때문에 무시됩니다.

페이지의 최신 버전 사용하기

start_page 키가 항상 지정된 페이지의 최신 버전을 가리키게 하려면, 페이지의 리소스 ID에 버전 좌표를 입력하지 마세요.

Example 2. antora-playbook.yml

site:
  title: Demo Docs Site
  url: https://demo.antora.org
  start_page: component-b::index.adoc

이 예시에서, Component B의 최신 버전이 2.0이라고 가정해보겠습니다. 이 경우, https://demo.antora.org/index.html은 https://demo.antora.org/component-b/2.0/index.html로 리디렉션됩니다.

페이지의 특정 버전 사용하기

사이트의 시작 페이지로 지정된 페이지의 특정 버전을 사용하고 싶다면, 리소스 ID에 버전 좌표를 포함시키세요.

Example 3. antora-playbook.yml

site:
  title: Demo Docs Site
  url: https://demo.antora.org
  start_page: 1.0@component-b::index.adoc

이 예시에서는 https://demo.antora.org/index.html이 https://demo.antora.org/component-b/1.0/index.html로 리디렉션됩니다.

컴포넌트 버전의 시작 페이지를 구성하려면 Choose a Start Page를 참조하세요.