Starlight

@lunariajs/starlight 包将 Lunaria 集成到 Starlight 文档主题 中，为使用 Starlight 的 Astro 站点添加 Lunaria 仪表板。

设置

1. 如果尚未完成，请按照快速入门指南中的步骤将 Lunaria 添加到您的项目。

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()],
       }),
     ],
   });

使用

默认情况下，会为您的 Astro 站点添加一个新的 /lunaria 路由，并与站点的生产构建一起生成。该路由可通过集成的 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",
        })],
    }),
  ],
});