# @catppuccin/starlight 中文文档

规范地址：https://npmcn.com/package/%40catppuccin/starlight/

版本：2\.1\.0
npm 元数据更新时间：2026-07-04T21:11:44.752Z
中文译文更新时间：2026-11-09T04:51:29.268Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40catppuccin/starlight
原文对照：https://npmcn.com/package/%40catppuccin/starlight/?lang=original
项目主页：https://starlight.catppuccin.com/
源码仓库：https://github.com/catppuccin/starlight

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：79.7 kB，61 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- 运行依赖：1 个
- peer 依赖：@astrojs/starlight \>=0\.38，astro ^6\.0\.0 \|\| ^7\.0\.0
- 首次发布：2025-04-18T17:57:07.085Z
- 最新版本发布：2026-07-04T21:11:44.382Z
- 近 30 天下载量：19571（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：7（近 12 个月 4 个）

## 中文简介

### ![Logo](https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/logos/exports/1544x1544_circle.png)

## 安装

```sh
npm install @catppuccin/starlight
```

也可以使用：`pnpm add @catppuccin/starlight`、`yarn add @catppuccin/starlight`、`bun add @catppuccin/starlight`

## README

### ![Logo](https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/logos/exports/1544x1544_circle.png)  
![](https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/misc/transparent.png) 产品 [星光](https://github.com/withastro/starlight) ![](https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/misc/transparent.png)

[![](https://img.shields.io/github/stars/catppuccin/starlight?colorA=363a4f&colorB=b7bdf8&style=for-the-badge)](https://github.com/catppuccin/starlight/stargazers) [![](https://img.shields.io/github/issues/catppuccin/starlight?colorA=363a4f&colorB=f5a97f&style=for-the-badge)](https://github.com/catppuccin/starlight/issues) [![](https://img.shields.io/github/contributors/catppuccin/starlight?colorA=363a4f&colorB=a6da95&style=for-the-badge)](https://github.com/catppuccin/starlight/contributors)

![](https://raw.githubusercontent.com/catppuccin/starlight/main/assets/preview.webp)

## 预览

拉铁 ![](https://raw.githubusercontent.com/catppuccin/starlight/main/assets/latte.webp)  费拉佩 ![](https://raw.githubusercontent.com/catppuccin/starlight/main/assets/frappe.webp)  马奇托 ![](https://raw.githubusercontent.com/catppuccin/starlight/main/assets/macchiato.webp)  {\\fn黑体\\fs22\\bord1\\shad0\\3aHBE\\4aH00\\fscx67\\fscy66\\2cHFFFFFF\\3cH808080}莫查 {\\fn黑体\\fs22\\bord1\\shad0\\3aHBE\\4aH00\\fscx67\\fscy66\\2cHFFFFFF\\3cH808080}你觉得呢 ![](https://raw.githubusercontent.com/catppuccin/starlight/main/assets/mocha.webp) 

## 使用量

1.  使用您首选的软件包管理器为您的项目安装主题包 :
    
    ```sh
    npm install @catppuccin/starlight
    pnpm add @catppuccin/starlight
    yarn add @catppuccin/starlight
    ```
    
2.  将主题添加到您的星光配置中 .
    
    ```ts
    import catppuccin from "@catppuccin/starlight";
    
    export default defineConfig({
      // ...
      integrations: [
        starlight({
          // ...
          plugins: [catppuccin()],
        }),
      ],
    });
    ```
    
3.  **(备选)** 使用光/暗模式自定义主题 `flavor` 财务报告和审定财务报表 `accent`。 。 。 .
    
    ```ts
    import catppuccin from "@catppuccin/starlight";
    
    export default defineConfig({
      // ...
      integrations: [
        starlight({
          // ...
          plugins: [
            catppuccin({
              dark: { flavor: "macchiato", accent: "sky" },
              light: { flavor: "latte", accent: "sky" },
            }),
          ],
        }),
      ],
    });
    ```
    

## 发展

> \[大  
> [cappuccin/ 密语](https://github.com/catppuccin/whiskers) 需要重新生成 [主题](https://npmcn.com/package/%40catppuccin/starlight/packages/catppuccin-starlight/themes) 目录.

```shell
pnpm install
pnpm build
```

## 谢谢

-   [奥特罗德](https://github.com/TheOtterlord)
-   [路易·埃舍尔](https://github.com/louisescher)
-   [费利克斯·施奈德](https://github.com/trueberryless)

![](https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/footers/gray0_ctp_on_line.svg?sanitize=true)

版权: 2021年至今 [猫头鹰](https://github.com/catppuccin)

[![](https://img.shields.io/static/v1.svg?style=for-the-badge&label=License&message=MIT&logoColor=d9e0ee&colorA=363a4f&colorB=b7bdf8)](https://github.com/catppuccin/catppuccin/blob/main/LICENSE)

## 常见问题

### 如何安装 @catppuccin/starlight？

在项目目录运行 npm install @catppuccin/starlight，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@astrojs/starlight（\>=0\.38）、astro（^6\.0\.0 \|\| ^7\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @catppuccin/starlight 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/catppuccin\_\_starlight 是否存在。

### @catppuccin/starlight 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @catppuccin/starlight 可以商用吗？

@catppuccin/starlight 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @catppuccin/starlight 的下载量有多少？

根据 npm 官方下载统计，@catppuccin/starlight 在 2026/10/09 – 2026/11/07 这 30 天内被下载 19,571 次，日均约 652 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @catppuccin/starlight 还在维护吗？

最新版本 2\.1\.0 发布于 2026/07/05（4 个月前）；至今共发布 7 个版本，其中过去 12 个月发布了 4 个；首次发布于 2025/04/19。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

