InstallationCopy Anchor Link

Option A: CLI (Recommended)Copy Anchor Link

Starting from scratch? Use --template with --name <project> to bootstrap a new docs project (Next.js, TanStack Start, Nuxt, SvelteKit, or Astro). No prompts — the CLI creates the project folder and runs install. See the --template section below.

Adding docs to an existing app? Run the init command inside your Next.js, TanStack Start, SvelteKit, Astro, or Nuxt project:

npx @farming-labs/docs init

The CLI will first ask: Are you adding docs to an existing project or starting fresh? Choose Existing project to add docs to the current directory. It will then:

1. Detect your framework (Next.js, TanStack Start, SvelteKit, Astro, or Nuxt), or ask you to pick one
2. Ask you to pick a theme (including Create your own theme, which prompts for a theme name and scaffolds themes/<name>.ts and themes/<name>.css)
3. Ask about path aliases and which global CSS file to use (defaults are offered; press Enter to accept)
4. Ask for the docs entry path (default: docs — press Enter to accept)
5. Optionally scaffold i18n by selecting locales, adding custom locale codes, and choosing a default locale TanStack Start currently skips the built-in i18n scaffold so the generated routes stay minimal and working
6. Generate config, layout, CSS, and sample pages
7. Install dependencies and optionally start the dev server

Prompts that show a placeholder (e.g. entry path, theme name) use that value as the default — you can press Enter to skip typing. See CLI — Init flow for the full sequence.

If you enable i18n, the CLI creates locale folders like docs/en and docs/fr, writes the i18n block to docs.config, and scaffolds the framework-specific files needed for routes like /docs?lang=en.

To upgrade all docs packages to the latest later, run from your project root: npx @farming-labs/docs upgrade (framework is auto-detected). See CLI — Upgrade for options.

Starting from scratch or want a full example? Use --template with --name <project> to bootstrap a ready-to-run docs app. The CLI creates the project folder, bootstraps it with the chosen framework, and runs install:

npx @farming-labs/docs init --template next --name my-docs     # Next.js
npx @farming-labs/docs init --template tanstack-start --name my-docs # TanStack Start
npx @farming-labs/docs init --template nuxt --name my-docs     # Nuxt
npx @farming-labs/docs init --template sveltekit --name my-docs # SvelteKit
npx @farming-labs/docs init --template astro --name my-docs    # Astro

Replace my-docs with your project name. Then run cd my-docs and start the dev server (npm run dev, pnpm run dev, yarn dev, or bun run dev).

Option B: Manual SetupCopy Anchor Link

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

import { defineDocs } from "@farming-labs/docs";
import { fumadocs } from "@farming-labs/theme";

export default defineDocs({
  entry: "docs",
  theme: fumadocs(),
  metadata: {
    titleTemplate: "%s – Docs",
    description: "My documentation site",
  },
});

import { withDocs } from "@farming-labs/next/config";
export default withDocs({});

import { RootProvider } from "@farming-labs/theme";
import "./global.css";

export default function RootLayout({
  children,
}: {
  children: React.ReactNode;
}) {
  return (
    <html lang="en" suppressHydrationWarning>
      <body>
        <RootProvider>{children}</RootProvider>
      </body>
    </html>
  );
}

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

app/docs/
  page.mdx              # /docs
  getting-started/
    page.mdx            # /docs/getting-started

---
title: "Getting Started"
description: "Your first doc page"
icon: "rocket"
---

# Getting Started

Your content here.