@farming-labs/svelte

中文文档
0.2.146发布于 2026/11/14MITTypeScriptES Module近 30 天下载 6136

SvelteKit adapter for @farming-labs/docs — content loading and navigation utilities

原始使用文档
文档目录6 节
  1. Package responsibilities
  2. Install
  3. Server integration
  4. Main entrypoints
  5. Learn more
  6. License

@farming-labs/svelte

The SvelteKit runtime adapter for @farming-labs/docs.

It loads Markdown, MDX, and SVX content, builds navigation, renders page content on the server, and provides SvelteKit handlers for docs, search, AI, agent discovery, MCP, and API references.

Package responsibilities

  • @farming-labs/docs — shared config, types, content features, and CLI
  • @farming-labs/svelte — SvelteKit content loading and server handlers
  • @farming-labs/svelte-theme — Svelte layout and UI components
  • @farming-labs/theme — shared preset CSS

Install

The CLI can wire the complete SvelteKit integration:

npx @farming-labs/docs@latest init

For manual installation:

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

Server integration

Preload content with Vite and create the docs server:

// src/lib/docs.server.ts
import { createDocsServer } from "@farming-labs/svelte/server";
import config from "./docs.config";

const contentFiles = import.meta.glob("/docs/**/*.{md,mdx,svx}", {
  query: "?raw",
  import: "default",
  eager: true,
}) as Record<string, string>;

export const { load, GET, HEAD, POST, MCP } = createDocsServer({
  ...config,
  _preloadedContent: contentFiles,
});

Re-export load from the docs +layout.server.ts and GET/HEAD/POST from the docs API route. Use DocsLayout and DocsContent from @farming-labs/svelte-theme for presentation. The CLI generates all of these files, including public agent and MCP forwarding.

Main entrypoints

EntrypointPurpose
@farming-labs/svelte/serverDocs server, loaders, API/MCP handlers, and API-reference helper
@farming-labs/svelte/contentContent discovery and navigation utilities
@farming-labs/svelte/markdownServer-side Markdown rendering
@farming-labs/svelte/configOptional mdsvex configuration helper
@farming-labs/svelte/api-referenceAPI-reference route handler

Learn more

License

MIT

版本与发布记录

@farming-labs/svelte 共发布 371 个版本,首次发布于 2026/02/19;过去 12 个月发布了 371 个版本。

版本发布日期距今
0.2.146latest2026/11/14今天
0.2.1452026/11/131 天前
0.2.1442026/11/131 天前
0.2.1432026/11/068 天前
0.2.1422026/11/068 天前
0.2.1412026/11/059 天前

其他发布通道:perf → 0.2.133-perf.1,beta → 0.2.139-beta.1。

关于 @farming-labs/svelte 的常见问题

@farming-labs/svelte 是什么?

SvelteKit adapter for @farming-labs/docs — content loading and navigation utilities

如何安装 @farming-labs/svelte?

在项目目录运行 npm install @farming-labs/svelte,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@farming-labs/docs(>=0.2.73 || ^0.2.133-perf.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@farming-labs/svelte 支持 TypeScript 吗?

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

@farming-labs/svelte 支持 ESM 还是 CommonJS?

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

@farming-labs/svelte 可以商用吗?

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

@farming-labs/svelte 的下载量有多少?

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

@farming-labs/svelte 还在维护吗?

最新版本 0.2.146 发布于 2026/11/14(今天);至今共发布 371 个版本,其中过去 12 个月发布了 371 个;首次发布于 2026/02/19。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。