Configuration - Krate Docs
You're viewing an older version ().
Krate Docs

The krate.config.ts entry point and a map of every option group.

#Configuration

Krate is configured with a krate.config.ts file at the project root, typed with defineConfig from @krate/core. Every supported key is type-checked — unknown or misspelled options become compile errors.

import { defineConfig, sitemap, docs } from '@krate/core';

export default defineConfig({
  entry: "src/index.tsx",
  outDir: "dist",
  pagesDir: "src/pages",
  minify: true,
  tailwind: { enabled: false, scanDirs: ["src"] },
  redirects: [{ source: "/old", destination: "/new", permanent: true }],
  plugins: [
    sitemap({ baseUrl: "https://example.com" }),
    docs({ contentDir: "src/content/docs", title: "Docs" }),
  ],
});

React syntax (useState, useEffect, useRef, JSX) is transpiled to Krate signals and effects automatically — no config is required. See React Compatibility.

#Option groups

This page is a map; the Config Reference documents every key and its default.

GroupKey(s)Reference
Buildentry, outDir, pagesDir, publicDir, minify, sourcemapBuild
Dev serverdevServerDev server
RenderingviewTransitions, ppr, ssr, outputSSR / Streaming
CSS & TailwindtailwindTailwind CSS
MarkdownmarkdownMarkdown
Contentcontent, pathAliases, tsBaseDirContent collections
Serverserver, basePath, redirects, rewritesServer
Securitycsp, corsContent Security Policy
SEOseo, robotsSEO & robots
CheckschecksQuality checks
PluginspluginsPlugins

Last updated: 2026-10-16

Contributors: Noinkin