| name | configuration |
| description | docs.config.ts options for @farming-labs/docs. Use when configuring entry, contentDir, theme, staticExport, nav, github, themeToggle, breadcrumb, sidebar, icons, components, metadata, og, onCopyClick, pageActions, or ai. Covers Next.js, SvelteKit, Astro, Nuxt config file location. |
@farming-labs/docs — Configuration
All configuration lives in a single docs.config.ts (or docs.config.tsx) file. Use this skill when editing or explaining config options.
Full docs: Configuration, API Reference.
Config file location by framework
| Framework | Config path |
|---|
| Next.js | Project root: docs.config.ts |
| SvelteKit | src/lib/docs.config.ts |
| Astro | src/lib/docs.config.ts |
| Nuxt | Project root: docs.config.ts |
SvelteKit, Astro, and Nuxt require contentDir (path to markdown files) and nav (sidebar title and base URL) in addition to entry and theme.
Main config options
| Option | Type | Default | Description |
|---|
entry | string | "docs" | URL path prefix for docs (e.g. "docs" → /docs) |
contentDir | string | same as entry | Path to content files (SvelteKit, Astro, Nuxt) |
staticExport | boolean | false | Set true for full static builds; hides search and AI |
theme | DocsTheme | — | Theme from a theme factory (e.g. fumadocs(), pixelBorder()) |
nav | { title, url } | — | Sidebar title and base URL (required for SvelteKit, Astro, Nuxt) |
github | string | GithubConfig | — | GitHub repo for "Edit on GitHub" and {githubUrl} in page actions |
themeToggle | boolean | ThemeToggleConfig | true | Light/dark mode toggle |
breadcrumb | boolean | BreadcrumbConfig | true | Breadcrumb navigation |
sidebar | boolean | SidebarConfig | true | Sidebar visibility and style |
icons | Record<string, Component> | — | Icon registry for frontmatter icon fields |
components | Record<string, Component> | — | Custom MDX components (e.g. Callout) |
onCopyClick | (data: CodeBlockCopyData) => void | — | Callback when user copies a code block (title, content, url, language) |
pageActions | PageActionsConfig | — | Copy Markdown, Open in LLM (see page-actions skill) |
ai | AIConfig | — | RAG-powered AI chat (see ask-ai skill) |
metadata | DocsMetadata | — | SEO: titleTemplate, description, etc. |
og | OGConfig | — | Dynamic Open Graph images |
Static export
For fully static builds (e.g. Cloudflare Pages, no server):
export default defineDocs({
entry: "docs",
staticExport: true,
theme: fumadocs(),
});
- Search (Cmd+K) and AI chat are hidden in the layout.
- Next.js: with
output: "export" in next.config, the /api/docs route is not generated.
- Do not deploy the docs API route when using static export.
GitHub (Edit on GitHub and openDocs)
github: {
url: "https://github.com/owner/repo",
directory: "website",
}
Enables "Edit on GitHub" links and allows {githubUrl} in pageActions.openDocs.providers.
Theme toggle
themeToggle: {
enabled: true,
default: "light" | "dark" | "system",
}
Set enabled: false to hide the toggle or force a single mode.
Sidebar and breadcrumb
- sidebar:
true (default) or SidebarConfig (style, banner, footer, etc.). See customization docs for banner/footer content.
- breadcrumb:
true (default) or BreadcrumbConfig to show/hide or configure breadcrumb.
Metadata and OG
- metadata:
titleTemplate, description, twitterCard, etc. for SEO.
- og:
enabled, type ("dynamic" | "static"), endpoint for dynamic OG image generation. See API reference and OG Images docs.
Ordering (sidebar)
Use ordering: "numeric" (default) so sidebar order follows frontmatter order (numbers). Doc pages can set order: 1, order: 2, etc. in frontmatter to control order.
Edge cases
- Next.js: Must wrap config with
withDocs() from @farming-labs/next/config in next.config.ts.
- SvelteKit/Astro: Server-side docs loader must receive config and (for AI) env vars; see framework docs.
- Nuxt:
defineDocsHandler(config, useStorage) in server/api/docs.ts; config is imported from root docs.config.ts.
Resources
