Starlight

@lunariajs/starlight パッケージは、Astro 用の Starlight ドキュメントテーマ に Lunaria を統合し、スターライトを備えた Astro サイトに Lunaria ダッシュボードを組み込みます。

構成

1. まだ行っていない場合は、「はじめに」ガイドでの Lunaria のプロジェクトへの追加手順に従ってください。

2. お好みのパッケージマネージャーで @lunariajs/starlight をプロジェクトに追加してください：

   npm

   npm install @lunariajs/starlight

   pnpm

   pnpm install @lunariajs/starlight

   Yarn

   yarn add @lunariajs/starlight

3. Starlight の plugins 配列フィールドに @lunariajs/starlight プラグインを追加してください：

   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 オプション を使って変更できます。

開発時にはダッシュボードも利用可能ですが、最初のアクセスは Lunaria が即座にステータスを生成するため遅くなる場合があります。以降のナビゲーションではステータスがキャッシュされ、新しいコミットが追加された時点で無効化されます。

オプション

sync

型: boolean
デフォルト: false

astro build コマンドを使用する際に、あなたの Lunaria 設定の defaultLocale、locales、および files フィールドが、Starlight の国際化設定 と同期されるかどうかを指定します：

astro.config.mjs

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

route

型: string
デフォルト: "/lunaria"

Lunaria ダッシュボードが挿入されるルートです。値は 有効な Astro ルートパターン文字列 でなければなりません：

astro.config.mjs

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

configPath

型: string
デフォルト: "./lunaria.config.json"

Lunaria 設定ファイルへの相対パスです：

astro.config.mjs

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