Book 옵션
book 프로젝트에서 사용 가능한 모든 옵션을 아래에 정리했습니다. Quarto로 책을 만드는 자세한 안내는 책 만들기를 참고하세요.
프로젝트
프로젝트의 유형, 렌더링 대상, 출력 등을 정의하는 옵션입니다. 프로젝트 옵션은 project 키 아래에 지정합니다. 예:
_quarto.yml
project:
type: book
output-dir: _booktitle |
프로젝트 제목 |
type |
프로젝트 유형( |
render |
렌더링할 파일 목록(기본 전체) |
execute-dir |
계산 작업 디렉터리 제어( |
output-dir |
출력 디렉터리 |
lib-dir |
HTML 라이브러리(JS/CSS 등) 디렉터리 |
resources |
출력에 복사할 추가 파일 |
brand |
brand.yml 경로 또는 밝기/어두움별 brand.yml 객체 |
preview |
|
pre-render |
사전 렌더 단계에서 실행할 스크립트 |
post-render |
사후 렌더 단계에서 실행할 스크립트 |
미리보기
preview 키에서 quarto preview의 동작을 제어하는 옵션을 지정합니다. 예:
_quarto.yml
project:
type: book
output-dir: _book
preview:
port: 4200
browser: false사용 가능한 preview 옵션은 다음과 같습니다.
port |
리스닝 포트(기본 3000~8000 사이 랜덤) |
host |
바인딩 호스트 이름(기본 127.0.0.1) |
serve |
외부 프리뷰 서버 옵션(Serve 참조) |
browser |
프리뷰 보기 브라우저 자동 열기(기본 true) |
watch-inputs |
입력 파일 변경 시 재렌더(기본 true) |
navigate |
출력이 업데이트되면 브라우저 자동 이동(기본 true) |
timeout |
활성 클라이언트 없을 때 종료까지 대기 시간(초) |
Serve
자체 미리보기 서버가 포함된 다른 배포 시스템(예: Hugo, Docusaurus)용 프로젝트 확장을 만들고 있다면, preview: serve 옵션으로 미리보기 서버 동작을 사용자 지정하세요.
_quarto.yml
project:
type: book
preview:
serve:
cmd: "hugo serve --port {port} --bind {host} --navigateToChanged"
env:
HUGO_RELATIVEURLS: "true"
ready: "Web Server is available at"cmd |
지정 명령으로 프로젝트 프리뷰 실행( |
args |
프리뷰 명령에 추가할 커맨드라인 인수 |
env |
프리뷰 명령 환경 변수 |
ready |
서버 준비 감지용 정규 표현식 |
preview: serve 사용 예시는 Hugo와 Docusaurus 확장 소스 코드를 참고하세요.
Book
book 출력에 영향을 주는 옵션입니다. Book 옵션은 book 키 아래에 지정합니다. 예:
_quarto.yml
book:
title: "My Book"
image: opengraph.png
page-navigation: truetitle |
책 제목 |
subtitle |
책 부제 |
author |
저자 또는 공동 저자 |
date |
출판일자 |
date-format |
책 내 날짜 형식 문자열 |
abstract |
책 초록 |
description |
HTML 버전 메타데이터 설명 |
references |
책 참고 문헌 파일 |
output-file |
단일 파일 출력 기본 이름(PDF/ePub/docx) |
cover-image |
표지 이미지(HTML/ePub 포맷) |
cover-image-alt |
표지 이미지 대체 텍스트(HTML) |
sharing |
네비게이션 또는 사이드바 공유 버튼( |
downloads |
네비게이션 또는 사이드바 다운로드 버튼( |
tools |
네비게이션 또는 사이드바용 사용자 도구 |
doi |
책의 DOI |
abstract-url |
초록 링크 URL |
accessed |
접근 날짜 |
annote |
항목에 대한 짧은 주석/장식(설명서용 |
archive |
소장 아카이브 |
archive-collection |
소속 아카이브 컬렉션 |
archive-location |
아카이브 내 물리적 위치(박스/폴더) |
archive-place |
아카이브 위치(지리적) |
authority |
발행/법원 기관 |
available-date |
초기 제공일(예: 공식 출판 전 온라인 공개 날짜) |
call-number |
도서관 내 분류 번호 |
chair |
세션 주도자(예: 연설/발표 개최자) |
chapter-number |
장 번호 |
citation-key |
입력 데이터 내 항목 식별자(한글 텍스트 변환 보조) |
citation-label |
본문 인용 레이블 스타일 식별자(e.g. “Ferr78”) |
collection-editor |
소장 컬렉션 편집자 |
collection-number |
컬렉션 번호 |
collection-title |
컬렉션 제목 |
compiler |
여러 소스를 편집/선정한 사람 |
composer |
작곡가 |
container-author |
소장 컨테이너 저자(예: 챕터 포함 책의 저자) |
container-title |
소장 컨테이너 제목(예: 챕터 포함 책 제목/저널 제목 등) |
contributor |
보조 기여자(참고문헌에서 “with”를 붙여 표기) |
curator |
큐레이터 |
dimensions |
물리적 또는 시간적 차원(크기/러닝타임) |
director |
감독 |
division |
법적 항목 관할 하위 부서 |
edition |
(컨테이너) 판 정보(예: 3판) |
editor |
편집자 |
editorial-director |
편집 이사 |
editor-translator |
편집자 겸 번역가 |
event-date |
관련 이벤트 날짜 |
event-title |
관련 이벤트 이름 |
event-place |
관련 이벤트 장소 |
executive-producer |
대표 제작자 |
fulltext-url |
전체 텍스트 URL |
genre |
항목 유형/분류(예: 박사학위 논문/NIH 보고서) |
guest |
게스트(예: TV 쇼/팟캐스트 출연자) |
host |
호스트(예: TV 쇼/팟캐스트 진행자) |
id |
항목 고유 식별자 |
illustrator |
일러스트레이터 |
interviewer |
인터뷰 진행자 |
isbn |
국제 표준 도서 번호(ISBN) |
issn |
국제 표준 연속 간행물 번호(ISSN) |
issue |
항목/컨테이너 호 번호(예: 저널 이슈); 호 제목은 |
issued |
발행/출간 날짜 |
jurisdiction |
적용 지역 범위(예: US 특허/재판 관할) |
keyword |
항목 키워드/태그 |
language |
항목 언어(ISO 639-1 코드 및 선택적 로케일로 표기) |
license |
적용 라이선스 정보(예: 논문/소프트웨어 라이선스, 저작권, 분류 상태) |
locator |
항목 내 인용 위치(페이지 숫자 등); locator 타입 레이블 필요 |
medium |
항목 형식/매체 설명(CD/DVD/앨범 등) |
narrator |
나레이터(예: 오디오북) |
note |
항목 설명 또는 주석 |
number |
항목 식별 번호(예: 보고서 번호) |
number-of-pages |
인용 항목 총 페이지 수 |
number-of-volumes |
전체 권 수(다권 도서) |
organizer |
행사 주최자 |
original-author |
원저자 설명(원본 저자/작곡가/개발자 등) |
original-date |
원본 초판 발행일 |
original-publisher |
원출판사 |
original-publisher-place |
원출판사 위치(예: London, UK) |
original-title |
원제 |
page |
컨테이너 내 페이지 범위 |
page-first |
컨테이너 내 시작 페이지 |
page-last |
컨테이너 내 끝 페이지 |
part-number |
인용 대상 일부 번호(예: 연재 중 2부); |
part-title |
인용 대상 일부 제목 |
pdf-url |
PDF URL |
performer |
수행자(예: 배우, 음악가) |
pmcid |
PubMed Central 번호 |
pmid |
PubMed 번호 |
printing-number |
인쇄 번호 |
producer |
제작자(예: 방송) |
public-url |
공개 URL |
publisher |
출판사 |
publisher-place |
출판사 위치 |
recipient |
수신인(예: 편지) |
reviewed-author |
현 항목이 리뷰하는 저자 |
reviewed-genre |
리뷰 대상 항목 유형(예: 책, 영화) |
reviewed-title |
리뷰 대상 제목 |
scale |
지도/모형 축척 |
script-writer |
대본/시나리오 작가 |
section |
항목/컨테이너의 섹션 |
series-creator |
시리즈 제작자 |
source |
출처(예: 도서관 카탈로그) |
status |
소장/공개 상태 |
submitted |
항목(예: 원고) 제출 날짜 |
supplement-number |
항목/컨테이너 증보 번호(판간 덧붙여진 법률 문서 등) |
translator |
번역가 |
type |
항목 유형 |
url |
항목 URL(예: https://example.com) |
version |
항목 버전(예: 소프트웨어 2.0.9) |
volume |
권 번호 |
volume-title |
권 제목 |
year-suffix |
저자-연도 스타일 구분 접미사(예: “Doe, 1999a”의 “a”) |
favicon |
웹사이트 파비콘 경로 |
site-url |
배포된 웹사이트 기본 URL |
site-path |
사이트 경로( |
repo-url |
웹사이트 소스 저장소 URL |
repo-link-target |
저장소 링크 target 속성 |
repo-link-rel |
저장소 링크 rel 속성 |
repo-subdir |
웹사이트가 포함된 저장소 하위 디렉터리 |
repo-branch |
웹사이트 소스 브랜치(기본 |
issue-url |
이슈 신고 리포지토리 URL |
repo-actions |
저장소 액션 링크( |
reader-mode |
사이드바/목차 숨김 reader-mode 도구 표시 |
google-analytics |
Google Analytics 활성화 |
cookie-consent |
쿠키 설정 스크립트 실행 전 쿠키 동의 요청 기능(https://www.cookieconsent.com/ 참고; GA 및 사용자 스크립트 제어에 활용) |
search |
사이트 검색 활성화( |
navbar |
네비게이션 바 옵션(Navbar 참조) |
sidebar |
사이드바 옵션(Sidebar 참조) |
body-header |
본문 시작부(title/author 아래) 삽입 Markdown |
body-footer |
본문 아래 삽입 Markdown |
margin-header |
여백 콘텐츠 위 Markdown |
margin-footer |
여백 콘텐츠 아래 Markdown |
page-navigation |
하단에 이전/다음 글 링크 |
back-to-top-navigation |
상단으로 이동 버튼 제공 |
bread-crumbs |
2단계 이상 페이지에 브레드크럼 표시 여부 |
page-footer |
페이지 하단 텍스트 또는 page footer |
image |
|
image-alt |
기본 썸네일 이미지 대체 텍스트 |
comments |
|
open-graph |
Open Graph 메타데이터 생성(Open Graph) |
twitter-card |
Twitter Card 메타데이터 생성(Twitter Card 참조) |
other-links |
목차 아래 표시할 기타 링크 |
code-links |
문서와 함께 표시할 코드 링크 목록 |
내비게이션 바
book의 상단 내비게이션 바를 정의하는 옵션입니다. 예:
_quarto.yml
book:
navbar:
search: true사이드바
book의 측면 내비게이션 영역을 정의하는 옵션입니다. 예:
_quarto.yml
book:
sidebar:
search: true사이드바 도구
사이드바에 표시되는 동작 버튼입니다. 예:
_quarto.yml
book:
sidebar:
tools:
- icon: github
href: https://github.com/푸터
Book 페이지의 푸터 정의입니다. 예:
_quarto.yml
book:
page-footer:
center:
- text: "About"
href: about.qmd
- text: "License"
href: license.md
- text: "Trademark"
href: trademark.qmd검색
검색 옵션은 book의 search 키 아래에 지정합니다. 예:
_quarto.yml
book:
search:
location: navbar
type: overlaylocation |
검색 위젯 위치( |
type |
검색 UI 유형( |
limit |
표시할 일치 항목 수(기본 20) |
collapse-after |
추가 결과를 축소할 일치 항목 기준 |
copy-button |
검색 링크 복사 버튼 제공 여부 |
merge-navbar-crumbs |
false면 |
keyboard-shortcut |
단일 문자 검색 단축키 목록 |
show-item-context |
검색 결과 항목 표시 시 상위 항목 포함 여부 |
algolia |
Algolia 인덱스를 사이트 검색에 사용(Algolia Options 참조) |
Algolia 옵션
Algolia 인덱스를 book 검색의 백엔드로 사용할 수 있습니다. search의 algolia 하위 키로 Algolia 옵션을 지정합니다. 예:
_quarto.yml
book:
search:
algolia:
index-name: <my-index-name>
application-id: <my-application-id>
search-only-api-key: <my-search-only-api-key>index-name |
검색 시 사용할 Algolia 인덱스 이름 |
application-id |
Algolia 애플리케이션 고유 ID |
search-only-api-key |
Algolia 연결용 Search-Only API 키 |
analytics-events |
Algolia 분석 이벤트 추적 활성화 |
show-logo |
검색 결과 바닥글에 Algolia 로고 표시 여부 |
index-fields |
검색 대상 필드 목록(자세한 내용은 아래 참조) |
params |
검색 실행 시 전달할 추가 파라미터 |
index-fields 옵션은 검색 대상이 되는 Algolia 인덱스의 하위 필드를 제공합니다.
href |
색인 항목 URL을 담는 필드 |
title |
색인 항목 제목을 담는 필드 |
text |
색인 항목 텍스트를 담는 필드 |
section |
색인 항목 섹션을 담는 필드 |
소셜
소셜 메타데이터는 book 옵션의 하위 키로 제공합니다. true를 지정해 기본 옵션으로 소셜 메타데이터를 생성하거나, 아래에 나열된 Twitter 또는 Open Graph 옵션을 하나 이상 지정할 수 있습니다. 예:
_quarto.yml
book:
open-graph: true
twitter-card:
site: "@sitehandle"Twitter 카드
twitter-card 키 아래에 Twitter 옵션을 지정하세요.
_quarto.yml
book:
twitter-card:
site: "@sitehandle"title |
페이지 제목(기본은 메타 제목; 재지정 가능) |
description |
콘텐츠 설명(기본은 메타 설명; 재지정 가능) |
image |
미리보기 이미지 경로(기본은 포맷 메타 이미지; 너비/높이 지정 가능) |
image-alt |
미리보기 이미지 대체 텍스트(기본은 포맷 메타) |
image-width |
이미지 너비(픽셀) |
image-height |
이미지 높이(픽셀) |
card-style |
카드 스타일( |
creator |
콘텐츠 제작자 Twitter |
site |
사이트 Twitter |
Open Graph
open-graph 키 아래에 Open Graph 옵션을 지정하세요.
_quarto.yml
book:
open-graph:
title: "Title for Open Graph"title |
페이지 제목(기본적으로 페이지 메타 제목 사용; 재지정 가능) |
description |
콘텐츠 요약 설명(기본 설명 대신 재정의할 수 있음) |
image |
미리보기 이미지 경로(기본은 메타 이미지; |
image-alt |
미리보기 이미지 대체 텍스트(기본은 메타 값; 폭/높이 지정 가능) |
image-width |
이미지 너비(픽셀) |
image-height |
이미지 높이(픽셀) |
locale |
Open Graph 메타데이터 로케일 |
site-name |
전체 사이트 표시 이름(미설정 시 사이트/도서 제목 사용) |
댓글
Hypothesis, Utterances, Giscus를 사용해 book에 댓글 기능을 추가할 수 있습니다.
Hypothesis
comments 키로 Hypothesis 댓글을 활성화하고 구성합니다. 예:
_quarto.yml
website:
comments:
hypothesis:
theme: clean
openSidebar: falseclient-url |
커스텀 Hypothesis 클라이언트 URL |
openSidebar |
시작 시 사이드바 자동 열림 여부 |
showHighlights |
文서 내 하이라이트 기본 표시 방식( |
theme |
사이드바 전체 테마( |
enableExperimentalNewNoteButton |
실험적 새 노트 버튼을 노트 탭에 표시할지 여부 |
usernameUrl |
주석 작성자 링크 클릭 시 새 탭으로 열 URL |
services |
서비스 정의 배열 |
branding |
UI에 적용할 커스텀 브랜딩/색상 |
externalContainerSelector |
사이드바 iframe을 넣을 외부 요소 CSS 셀렉터 |
focus |
페이지 주석에 대한 사용자 중심 필터 셋 |
requestConfigFromFrame |
설정 요청 대상 호스트 iframe 지정 |
assetRoot |
자산 로드용 루트 URL |
sidebarAppUrl |
주석 표시 사이드바 앱 URL |
위에 나열된 Hypothesis 옵션에 대한 추가 문서는 Hypothesis Publisher Config를 참고하세요.
Utterances
comments 키로 Utterances 댓글을 활성화하고 구성합니다. 예:
_quarto.yml
website:
comments:
utterances:
repo: quarto-dev/quarto-webrepo |
댓글을 저장할 Github 저장소 |
label |
Utterances가 생성한 이슈에 붙일 레이블 |
theme |
Utterances에 사용할 Github 테마(예: github-light, github-dark 등) |
issue-term |
배포물을 Github 이슈로 매핑하는 방식( |
Giscus
comments 키로 Giscus 앱 사용을 활성화하고 구성합니다. 예:
_quarto.yml
website:
comments:
giscus:
repo: quarto-dev/quarto-webrepo |
코멘트를 저장할 GitHub 저장소입니다. 정상 작동하려면 저장소가 공개여야 하며 giscus 앱이 설치되어 있고 토론 기능이 활성화되어야 합니다. |
repo-id |
GitHub 저장소 식별자입니다. https://giscus.app 구성 도구에서 빠르게 확인할 수 있습니다. 제공하지 않으면 Quarto가 렌더링 시점에 자동으로 찾아봅니다. |
category |
새 토론을 만들 토론 카테고리입니다. 신규 토론을 유지 관리자와 giscus만 생성할 수 있도록 Announcements 유형 카테고리를 사용하는 것이 권장됩니다. |
category-id |
GitHub 카테고리 식별자입니다. https://giscus.app 구성 도구에서 빠르게 확인할 수 있습니다. 제공하지 않으면 Quarto가 렌더링 시점에 자동으로 찾아봅니다. |
mapping |
페이지와 임베드된 토론 사이의 매핑입니다.
|
reactions-enabled |
댓글보다 앞서 토론 메인 배포물에 대한 반응을 표시합니다. |
loading |
|
input-position |
댓글 입력 상자를 댓글 위나 아래에 배치합니다. |
theme |
댓글을 표시할 때 사용할 giscus 테마입니다. 밝은 테마와 어두운 테마를 모두 지원합니다. 하나의 테마 이름만 제공하면 밝거나 어두운 테마 모두 해당 이름이 사용됩니다. 서로 다른 테마를 지정하려면 |
language |
댓글 인터페이스를 표시할 때 사용할 언어입니다. |
목록
목록은 Quarto 문서 목록이나 기타 사용자 정의 데이터로 페이지(또는 페이지의 일부) 내용을 자동 생성합니다. 문서 프론트매터의 listing 옵션으로 목록을 활성화할 수 있습니다. 예를 들어 listing: default를 설정하면 현재 문서를 제외한 디렉터리의 모든 문서를 목록으로 생성합니다.
---
title: "Listing Example"
listing: default
---목록을 사용자 지정하려면 listing 키 아래에 추가 옵션을 지정하세요.
---
title: "Listing Example"
listing:
contents: posts
type: grid
grid-columns: 2
---id |
목록 ID 및 |
type |
생성할 목록 유형( |
contents |
목록에 포함할 문서/야믈 파일 경로 또는 glob |
sort |
정렬 필드 및 방향( |
max-items |
최대 항목 수 |
page-size |
페이지당 항목 수 |
sort-ui |
정렬 컨트롤 표시 여부(표시 필드 목록 제공 가능) |
filter-ui |
필터링 컨트롤 표시 여부 및 필드 목록 |
categories |
페이지 여백에 카테고리 표시( |
feed |
목록 항목으로 RSS 피드 생성(Feed 참조) |
date-format |
날짜 표시 형식(예: d-M-yyy; https://deno.land/std@0.125.0/datetime 참고) |
max-description-length |
표시 설명 최대 문자 수(기본 175) |
image-placeholder |
이미지 없을 때 사용할 기본 이미지 |
image-lazy-loading |
false면 즉시 로드, true면 뷰포트 진입 시 로드 |
image-align |
|
image-height |
이미지 높이(CSS 문자열; 너비 자동, 자르기 포함) |
grid-columns |
그리드 목록 열 수(기본 3) |
grid-item-border |
그리드 항목 카드 테두리 표시 여부(기본 true) |
grid-item-align |
그리드 항목 내용 정렬( |
table-striped |
테이블 목록 줄 무늬 배경 표시 여부(기본 false) |
table-hover |
테이블 목록에서 마우스 오버 시 행 강조(기본 false) |
template |
사용자 정의 목록 템플릿 경로 |
template-params |
사용자 템플릿에 전달할 파라미터 |
fields |
목록에 포함할 필드 목록 |
field-display-names |
특정 필드의 표시명 매핑 |
field-types |
필드 데이터 타입 지정( |
field-links |
테이블 유형에서 링크로 표시할 필드 목록(기본 |
field-required |
필수 필드 목록(없으면 렌더 오류) |
include |
일치하는 필드 값을 가진 항목 포함 |
exclude |
일치하는 필드 값을 가진 항목 제외 |
피드
feed 옵션을 포함해 목록의 RSS 피드를 활성화할 수 있습니다.
---
title: "Listing Example"
listing:
contents: posts
feed:
items: 10
---items |
피드에 포함할 항목 수(기본값 20) |
type |
피드에 포함할 콘텐츠 유형
|
title |
피드 제목(지정되지 않으면 Quarto 프로젝트 사이트 제목) |
image |
피드용 이미지 경로(미지정 시 목록 페이지 또는 프로젝트 사이트 이미지 사용) |
description |
피드 설명(미지정 시 목록 페이지 또는 프로젝트 사이트 설명 사용) |
language |
피드 언어(미지정 시 생략; 유효 언어 코드 목록은 https://www.rssboard.org/rss-language-codes 참고) |
categories |
각 카테고리별 RSS 피드를 생성할 카테고리 목록 |
xml-stylesheet |
RSS 피드 스타일링에 사용할 XML 스타일시트(XSL) 경로 |
About
개인 또는 조직의 간단한 소개 페이지를 레이아웃합니다. 문서 프론트매터의 about 키 아래에 소개 페이지 옵션을 지정하세요.
---
title: About
about:
template: jolla
image: profile.jpg
links:
- icon: twitter
text: twitter
href: https://twitter.com
---자세한 내용은 About 페이지 문서를 참고하세요.
id |
about 페이지 대상 ID. 해당 ID를 가진 |
template |
about 페이지 레이아웃 템플릿 목록( |
image |
about 페이지 메인 이미지 경로(미지정 시 문서 지정 |
image-alt |
about 페이지 메인 이미지 대체 텍스트. |
image-title |
about 페이지 메인 이미지 제목. |
image-width |
about 페이지 이미지 유효 CSS 너비. |
image-shape |
about 페이지 이미지 형태( |
links |
about 페이지에 표시할 링크 목록(navigation items 참조). |