Starlight

@lunariajs/starlight 패키지는 Starlight 문서 테마를 사용하는 Astro에 대해 Lunaria를 통합하며, 스타라이트와 함께 당신의 사이트에 룬아리아 대시보드를 포함시킵니다.

설치

1. 아직 진행하지 않았다면, 시작 가이드에서 프로젝트에 룬아리아를 추가하는 단계를 따르세요.

2. 선호하는 패키지 매니저를 사용하여 @lunariajs/starlight를 프로젝트에 추가하세요:

   npm

   npm install @lunariajs/starlight

   pnpm

   pnpm install @lunariajs/starlight

   Yarn

   yarn add @lunariajs/starlight

3. @lunariajs/starlight 플러그인을 Starlight의 plugins 배열 필드에 추가하세요:

   astro.config.mjs

   import starlight from '@astrojs/starlight';
   import lunaria from '@lunariajs/starlight';
   import { defineConfig } from 'astro/config';
   
   export default defineConfig({
     integrations: [
       starlight({
         plugins: [lunaria()],
       }),
     ],
   });

사용법

기본적으로 새 /lunaria 경로가 당신의 Astro 사이트에 추가되며, 사이트의 프로덕션 빌드와 함께 빌드됩니다. 이 경로는 통합의 route 옵션을 사용하여 변경할 수 있습니다.

개발 중에도 대시보드에 접근할 수 있지만, 처음 접속 시 룬아리아가 즉각적인 상태를 생성하기 때문에 느릴 수 있습니다. 이후 탐색에서는 상태가 캐시되며, 새로운 커밋이 추가될 때 다시 무효화됩니다.

옵션

sync

유형: boolean
기본값: false

astro build 명령어를 사용할 때, 당신의 룬아리아 구성 파일의 defaultLocale, locales, files 필드가 Starlight i18n 구성과 동기화되어야 하는지를 지정합니다:

astro.config.mjs

export default defineConfig({
  integrations: [
    starlight({
        plugins: [lunaria({
            sync: true,
        })],
    }),
  ],
});

route

유형: string
기본값: "/lunaria"

룬아리아 대시보드가 삽입될 경로입니다. 값은 유효한 Astro 경로 패턴 문자열이어야 합니다:

astro.config.mjs

export default defineConfig({
  integrations: [
    starlight({
        plugins: [lunaria({
            route: "/dashboard",
        })],
    }),
  ],
});

configPath

유형: string
기본값: "./lunaria.config.json"

당신의 룬아리아 구성 파일까지의 상대 경로입니다:

astro.config.mjs

export default defineConfig({
  integrations: [
    starlight({
        plugins: [lunaria({
            configPath: "./lunaria/config.json",
        })],
    }),
  ],
});