公开 API

查阅 svedocs 对外提供的稳定导出。

请从下面列出的包路径导入公开 API。即使内部实现以后在子目录间调整，这些入口也会保持精简和稳定。

Config

TypeScript
1import { defineConfig, loadSvedocsConfig } from 'svedocs/config';

defineConfig 用来拿类型提示，loadSvedocsConfig 用来读解析后的默认值。

Vite

TypeScript
1import { svedocs } from 'svedocs/vite';

这个插件提供虚拟模块、内容刷新、MDX/SVX 组件编译、注入式作者组件和命名布局注册。

编译期 Markdown 钩子放在 svedocs.config.ts 中：

TypeScript
1export default defineConfig({2  markdown: {3    remarkPlugins: [],4    rehypePlugins: [],5    shiki: {6      transformers: []7    }8  }9});

这些钩子会在 svedocs 构建页面列表并渲染兼容 Svelte 的 .svx/.mdx 文件时运行，不会被序列化进浏览器虚拟模块。

虚拟模块：

模块	内容
`virtual:svedocs/config`	解析后的配置
`virtual:svedocs/pages`	完整页面列表
`virtual:svedocs/page-index`	用于客户端路由匹配的轻量页面索引
`virtual:svedocs/page-loaders`	完整单页数据的动态加载器
`virtual:svedocs/tree`	侧栏树
`virtual:svedocs/search`	搜索记录
`virtual:svedocs/search-loader`	客户端搜索记录的动态加载器
`virtual:svedocs/components`	编译后的 `.svx/.mdx` 组件
`virtual:svedocs/layouts`	注册的自定义布局
`virtual:svedocs/theme-components`	注册的主题组件替换

Core

TypeScript
1import {2  loadSvedocsContent,3  createPageTree,4  createSearchRecords,5  checkSvedocsContent6} from 'svedocs/core';7import { resolveSvedocsPageRoute, resolveSvedocsHref } from 'svedocs/routes';

核心 API 包含内容加载、导航、链接、检查和搜索记录。浏览器安全的 svedocs/routes 入口提供 resolveSvedocsPageRoute，用于加载 canonical 路由并处理默认语言重定向；resolveSvedocsHref 对链接应用同一套语言规则。

Theme

TypeScript
1import {2  DocsApp,3  RootLayout,4  LayoutShell,5  DocsLayout,6  DocsShell,7  DocPage,8  Article,9  PageLayout,10  PageShell,11  ErrorPage,12  RenderError,13  Navbar,14  TableOfContents,15  Footer,16  PageTools,17  HomePage,18  FormField,19  Input,20  Select,21  Textarea,22  Checkbox,23  Button,24  LocalizedLink25} from 'svedocs/theme';26import 'svedocs/theme/styles.css';27import 'svedocs/theme/base.css';28import { createSearchController, createAskAiController } from 'svedocs/theme/headless';29import type { SvedocsThemeComponentMap, SvedocsNavbarProps } from 'svedocs/theme/types';

完整的路由外壳可以直接使用 DocsApp，也可以组合更底层的组件构建自定义站点。自定义页面和布局中的表单可以使用这些基础控件，以继承 svedocs 默认主题。开发完整的自定义主题时，可以通过 themeComponents 替换默认组件，并复用无样式控制器。每个组件的属性见组件。

Cloudflare

TypeScript
1import { createCloudflarePreset, createWranglerJsonc, createCloudflareEnvDts } from 'svedocs/cloudflare';

这些辅助函数会协调 SvelteKit 构建模式、wrangler.toml 或 wrangler.jsonc，以及平台绑定类型。

Search 和 AI

TypeScript
1import { createConfiguredSearchResponse, createSearchResponse, searchRecords } from 'svedocs/search';2import { createConfiguredAskResponse, createAskResponse, createMemoryRateLimiter } from 'svedocs/ai';

搜索和 Ask AI 支持本地、Algolia、Typesense、Cloudflare 和 OpenAI 兼容服务。本地搜索可以按语言和内容类型过滤结果。

生成的路由应优先使用配置感知的响应函数。只有需要自定义路由或服务选择时，才直接导入 createAlgoliaSearchProvider、createTypesenseSearchProvider、createCloudflareAiSearchProvider、createWorkersAiProvider 或 createOpenAiCompatibleProvider。

OG

TypeScript
1import {2  createPageMetadata,3  createPageAlternates,4  createSitemapXml,5  createRobotsTxt,6  createPageOgImageResponse,7  createOgImageInput,8  createOgImage9} from 'svedocs/og';

这些 API 可用于自定义路由处理函数、布局和构建期 OG 图片生成。