컨텐츠로 이동

시작하기

새 프로젝트 생성

Starlight는 Astro 프레임워크 위에 구축되었으며, 완전한 기능을 갖춘 문서 테마입니다. 이 가이드는 새 프로젝트를 시작하는 데 도움이 될 것입니다. 기존 Astro 프로젝트에 Starlight를 추가하려면 수동 설정 지침을 참조하세요.

빠른 시작

새 프로젝트 생성

터미널에서 다음 명령을 실행하여 새 Astro + Starlight 프로젝트를 생성합니다.

npm create astro@latest -- --template starlight

이 명령은 필요한 파일과 구성을 모두 갖춘 새 프로젝트 디렉터리를 생성합니다.

개발 서버 시작

로컬에서 작업할 때 Astro의 개발 서버를 사용하면 작업을 미리 볼 수 있으며 변경 시 자동으로 브라우저를 새로 고칠 수 있습니다.

프로젝트 디렉터리에서 다음 명령을 실행하여 개발 서버를 시작합니다.

npm run dev

그러면 로컬 미리보기의 URL이 포함된 메시지가 터미널에 기록됩니다. 사이트 탐색을 시작하려면 이 URL을 여세요.

콘텐츠 추가

Starlight는 새로운 콘텐츠를 추가하거나 기존 파일을 가져올 준비가 되어 있습니다!

파일 형식

Starlight는 별도의 구성 없이 Markdown 및 MDX에서 콘텐츠를 작성을 지원합니다. 실험적인 Astro Markdoc 통합을 설치하여 Markdoc에 대한 지원을 추가할 수 있습니다.

페이지 추가

src/content/docs/ 디렉터리에 .md 또는 .mdx 파일을 생성하여 사이트에 새 페이지를 추가하세요. 하위 폴더를 사용하여 파일을 구성하고 여러 경로 세그먼트를 만듭니다.

예를 들어, 다음 파일 구조는 example.com/hello-worldexample.com/guides/faq에 페이지를 생성합니다.

  • Directorysrc/
    • Directorycontent/
      • Directorydocs/
        • Directoryguides/
          • faq.md
        • hello-world.md

타입 안정성을 갖춘 프런트매터

모든 Starlight 페이지는 페이지의 외관을 제어하기 위해 사용자가 원하는 대로 변경 가능한 공통 프론트매터 속성 세트를 공유합니다.

---
title: 안녕하세요!
description: Starlight 기반 사이트의 페이지입니다.
---

중요한 것을 잊어버렸다면, Starlight가 알려줄 것입니다.

다음 단계

Starlight 업데이트

Starlight는 Astro 통합이므로 @astrojs/*로 업데이트할 수 있습니다.

npm install @astrojs/starlight@latest

각 릴리스의 전체 변경 사항 목록은 Starlight 변경 로그를 참조하세요.

Starlight 문제 해결

프로젝트 구성개별 페이지 프런트매터 구성 참조 페이지를 사용하여 Starlight 사이트가 올바르게 구성되고 작동하는지 확인하세요. 콘텐츠를 추가하고 Starlight 사이트를 사용자 정의하는 데 도움이 필요하면 사이드바의 가이드를 참조하세요.

이 문서에서 답변을 찾을 수 없다면 완전한 Astro 문서를 확인하기 위해 Astro 공식 문서를 방문하세요. 이 Starlight 테마에서 Astro가 어떻게 작동하는지 이해하는 것은 질문에 대한 해답이 될 것입니다.

Github issues에서 Starlight의 알려진 문제를 확인할 수 있으며, 활발하고 친근한 커뮤니티인 Astro Discord에서 도음을 받을수도 있습니다! 현재 진행되고 있는 개발 및 기타 주제에 대해 논의하기 위해 #support 채널에서 “starlight” 태그를 사용하여 질문을 게시하거나 #starlight 채널을 방문하세요.