스타터 템플릿

개요

스타터 템플릿은 예제 콘텐츠와 옵션을 제공해 사용자가 새 Quarto 프로젝트를 쉽게 시작하도록 돕습니다. 스타터 템플릿은 다음과 같이 활용할 수 있습니다:

  1. 저널 아티클 또는 커스텀 포맷용 초기 문서를 만듭니다.

  2. 커스텀 프로젝트 유형의 초기 콘텐츠를 제공합니다.

  3. 조직에서 사용하는 표준 데이터 분석 프로젝트 골격을 제공합니다.

스타터 템플릿은 사용자의 시스템에서 새 디렉터리로 복사되는 GitHub 저장소입니다. 아래의 확장과 템플릿에서 설명하듯이, 커스텀 포맷 저장소가 스타터 템플릿으로도 사용되는 경우가 많습니다.

템플릿 만들기

스타터 템플릿을 만들려면, 템플릿으로 생성되는 프로젝트에 복사할 파일을 포함한 GitHub 저장소를 만들면 됩니다. 저장소의 모든 파일이 복사되지만 다음은 제외됩니다:

  1. 숨김 파일(.으로 시작하는 모든 파일/디렉터리, 예: .gitignore).

  2. README.md, LICENSE 같은 일반적인 GitHub 저장소 파일.

원한다면 저장소 루트에 .quartoignore 파일을 추가해 제외할 파일/디렉터리를 지정할 수 있습니다. 각 줄은 .gitignore와 유사한 문법의 glob 패턴이어야 합니다.

template.qmd

문서 생성용 템플릿(프로젝트가 아닌 경우)에 보통 포함하는 특별한 파일이 template.qmd입니다. 이를 포함하는 이유는 두 가지입니다:

  1. 템플릿이 예상대로 동작하는지 쉽게 테스트할 수 있습니다.

  2. 템플릿이 대상 디렉터리로 복사될 때 template.qmd는 사용자가 지정한 디렉터리 이름에 맞게 자동으로 이름이 변경됩니다.

웹사이트나 책 생성을 위한 템플릿이라면 index.qmd가 그 역할을 하므로 template.qmd는 보통 필요하지 않습니다.

템플릿 사용

템플릿 저장소를 만들고 GitHub에 푸시한 다음, 다음 명령으로 사용할 수 있습니다:

Terminal
quarto use template cooltools/cool-project

이 명령은 https://github.com/cooltools/cool-project 저장소의 내용을 로컬 시스템으로 복사합니다(위에서 설명한 제외 파일은 제외).

명령을 빈 디렉터리에서 실행하면 기존 디렉터리를 사용할지 새 디렉터리를 만들지 묻게 됩니다. 다른 파일/디렉터리가 있는 위치에서 실행하면 생성할 디렉터리 이름을 묻게 됩니다.

확장과 템플릿

저널 아티클, 커스텀 포맷, 프로젝트 유형 확장을 만들 때는 사용자 시작을 돕기 위해 스타터 템플릿을 함께 제공하는 것을 권장합니다.

보통은 확장에 사용 예시를 보여주는 template.qmd 파일을 추가하는 것만으로 충분합니다. 이 구성에서는 템플릿으로 시작하거나 일반적인 quarto install로 확장을 설치해 사용할 수 있습니다.

예를 들어 ACM 저널 아티클 확장을 보겠습니다. 이 확장 저장소는 템플릿으로 시작하는 방법을 제공합니다:

Terminal
quarto use template quarto-journals/acm

또는 템플릿 없이 기존 프로젝트나 디렉터리에 포맷만 추가할 수도 있습니다:

Terminal
quarto add quarto-journals/acm