# @farming-labs/svelte-theme 中文文档

规范地址：https://npmcn.com/package/%40farming-labs/svelte-theme/

版本：0\.2\.146
npm 元数据更新时间：2026-11-13T20:32:56.060Z
中文译文更新时间：2026-11-14T10:33:57.164Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40farming-labs/svelte-theme
原文对照：https://npmcn.com/package/%40farming-labs/svelte-theme/?lang=original

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

- 包体积（解压后）：464 kB，60 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：4 个
- peer 依赖：svelte \>=5\.0\.0
- 首次发布：2026-02-18T22:45:12.308Z
- 最新版本发布：2026-11-13T20:32:55.823Z
- 近 30 天下载量：6037（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：369（近 12 个月 369 个）

## 中文简介

用于 @ farming- labs/ docs的 Svelte UI 组件 — 排版、侧边栏、 TOC、 搜索和主题切换

## 安装

```sh
npm install @farming-labs/svelte-theme
```

也可以使用：`pnpm add @farming-labs/svelte-theme`、`yarn add @farming-labs/svelte-theme`、`bun add @farming-labs/svelte-theme`

## README

# @农作-实验室/svelte-主题

Svelte 5 UI 层和主题预设软件包 [`@farming-labs/docs`](https://www.npmjs.com/package/@farming-labs/docs) 在斯维尔特基特.

它使文档 shell, 页面内容, 侧边栏, 目录, 搜索, AI 对话框, 页面 动作和主题控件。 内容加载和路由处理者居住 `@farming-labs/svelte`。 。 。 .

## 安装

```bash
npm install @farming-labs/docs @farming-labs/svelte @farming-labs/svelte-theme @farming-labs/theme
```

CLI可以脚手架 完整的SvelteKit集成:

```bash
npx @farming-labs/docs@latest init
```

## 配置主题

```ts
// src/lib/docs.config.ts
import { defineDocs } from "@farming-labs/docs";
import { fumadocs } from "@farming-labs/svelte-theme";

export default defineDocs({
  entry: "docs",
  contentDir: "docs",
  theme: fumadocs(),
  nav: { title: "Docs", url: "/docs" },
});
```

导入匹配的共享 CSS `src/app.css`数字 :

```css
@import "@farming-labs/theme/default/css";
```

## 打开文件UI

```svelte
<script>
  import { DocsLayout } from "@farming-labs/svelte-theme";
  import config from "$lib/docs.config";

  let { data, children } = $props();
</script>

<DocsLayout tree={data.tree} {config}>
  {@render children()}
</DocsLayout>
```

使用 `DocsContent` 从页面组件中的同一软件包中。 这个 `data` 传给这些 组件来自 `@farming-labs/svelte/server`。 。 。 .

## 主要出口

-   `DocsLayout`, (中文(简体) ), `DocsContent`, (中文(简体) ), `DocsSidebar`,以及 `DocsPage`
-   `TableOfContents`, (中文(简体) ), `Breadcrumb`, (中文(简体) ), `MobileNav`,以及 `ThemeToggle`
-   `SearchDialog`, (中文(简体) ), `AskAIDialog`,以及 `FloatingAIChat`
-   `Callout` 和主题预设工厂

预设子路径为 `fumadocs`, (中文(简体) ), `pixel-border`, (中文(简体) ), `darksharp`, (中文(简体) ), `colorful`, (中文(简体) ), `greentree`, (中文(简体) ), `hardline`, (中文(简体) ), `concrete`, (中文(简体) ), `command-grid`,以及 `ledger`编辑 `fumadocs` 预设用途 `@farming-labs/theme/default/css`; 其他预设使用匹配 `@farming-labs/theme/<preset>/css` 进入点.

## 学多点

-   [文档](https://docs.farming-labs.dev/docs)
-   [主题](https://docs.farming-labs.dev/docs/themes)
-   [SvelteKit 实例](https://github.com/farming-labs/docs/tree/main/examples/sveltekit)
-   [GitHub 仓库](https://github.com/farming-labs/docs)

## 许可证

麻省理工学院

## 可选 AI 装入

浮动的AI触发器与页面一起加载. 第一次激活时它的聊天执行负载 关闭后继续挂起 所以重开对话 面板,模式,弹出式, 完整模式和自定义触发器保留其现有的标记和配置.

## 常见问题

### @farming-labs/svelte-theme 是什么？

用于 @ farming- labs/ docs的 Svelte UI 组件 — 排版、侧边栏、 TOC、 搜索和主题切换

### 如何安装 @farming-labs/svelte-theme？

在项目目录运行 npm install @farming-labs/svelte-theme，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：svelte（\>=5\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @farming-labs/svelte-theme 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @farming-labs/svelte-theme 支持 ESM 还是 CommonJS？

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

### @farming-labs/svelte-theme 可以商用吗？

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

### @farming-labs/svelte-theme 的下载量有多少？

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

### @farming-labs/svelte-theme 还在维护吗？

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