Public API

Stable public imports exposed by the integrated svedocs framework package.

Import public APIs from the package paths shown below. Their entry files stay small and stable even when the implementation moves between internal directories.

Config

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

Use defineConfig for typed configuration and loadSvedocsConfig for resolved defaults.

Vite

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

The plugin provides virtual modules, content refresh, MDX/SVX component compilation, injected authoring components, and named layout registration.

Compile-time Markdown hooks live in svedocs.config.ts:

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

These hooks run while svedocs builds the page list and renders Svelte-compatible .svx/.mdx files. They are not serialized into browser virtual modules.

Virtual modules:

Module	Value
`virtual:svedocs/config`	Resolved config
`virtual:svedocs/pages`	Complete page list
`virtual:svedocs/page-index`	Lightweight page index for client route matching
`virtual:svedocs/page-loaders`	Dynamic loaders for full per-page data
`virtual:svedocs/tree`	Sidebar tree
`virtual:svedocs/search`	Search records
`virtual:svedocs/search-loader`	Dynamic loader for client-side search records
`virtual:svedocs/components`	Compiled `.svx/.mdx` components
`virtual:svedocs/layouts`	Registered custom layouts
`virtual:svedocs/theme-components`	Registered theme component overrides

Core

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

Core APIs cover content loading, navigation, links, checks, and search records. The browser-safe svedocs/routes entry exposes resolveSvedocsPageRoute for canonical route loading and default-locale redirects, plus resolveSvedocsHref for applying the same locale rules to links.

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';

Use DocsApp for the complete route shell or compose lower-level components for custom apps. Use the form controls in custom pages and layouts when you want project UI to inherit the default svedocs theme. Use themeComponents plus the headless controllers when building a fully custom theme without the default stylesheet. See Components for the per-component props.

Cloudflare

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

These helpers align SvelteKit build modes, wrangler.toml or wrangler.jsonc, and platform binding types.

Search and AI

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

Search and Ask AI support local, Algolia, Typesense, Cloudflare, and OpenAI-compatible services. Local search can filter by locale and content kind.

Generated route handlers should use the configured response utilities. Import lower-level providers such as createAlgoliaSearchProvider, createTypesenseSearchProvider, createCloudflareAiSearchProvider, createWorkersAiProvider, or createOpenAiCompatibleProvider only when you need custom routing or service selection.

OG

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

Use these APIs for custom route handlers, custom layouts, and build-time OG generation.