Configuration Reference

export default {
  title: "My Project Documentation",
  description: "High-performance developer documentation",
  docs: "./docs",           // Source directory (default: "./docs" or ".")
  out: "./dist",            // Output directory (default: "./dist")
  repo: "https://github.com/org/my-project" // Repository link for header
};

export default {
  editLink: {
    pattern: "https://github.com/org/my-project/edit/main/docs/:path",
    text: "Edit this page on GitHub"
  },
  sourceLink: {
    pattern: "https://github.com/org/my-project/blob/main/docs/:path",
    text: "View source"
  }
};

export default {
  theme: {
    preset: "zinc",          // "zinc" | "ocean" | "emerald" | "violet" | "amber" | "rose"
    defaultMode: "system",   // "system" | "dark" | "light"
    themeToggle: true,       // Show light/dark mode icon
    presetMenu: true,        // Show theme & font customizer menu
    fontSizeControl: true    // Show A- / A+ reading font size stepper
  }
};

export default {
  search: {
    fuzzy: 0.2,       // Fuzzy matching threshold (0 = exact, 0.2 = default)
    prefix: true,      // Match prefix substrings while typing
    maxResults: 10,    // Maximum number of visible results in modal
    minQueryLength: 2  // Minimum characters before executing search
  }
};

export default {
  embeds: {
    allowedDomains: [
      "youtube.com",
      "codesandbox.io",
      "stackblitz.com",
      "codepen.io",
      "vimeo.com"
    ]
  }
};

export default {
  base: "/my-project/",              // Custom base path (e.g. GitHub Pages repo name)
  customDomain: "docs.example.com"   // Generates dist/CNAME file
};

export default {
  analytics: {
    google: { id: "G-XXXXXXXXXX" },
    plausible: { domain: "docs.example.com", apiHost: "https://plausible.io" },
    umami: { websiteId: "xxxx-xxxx", src: "https://analytics.umami.is/script.js" },
    fathom: { siteId: "XXXXXX" },
    clarity: { id: "XXXXXXXXXX" },
    custom: `<script defer src="https://my-cdn.com/analytics.js"></script>`
  }
};

export default {
  pwa: true // Generates manifest.webmanifest and sw.js for offline reading
};

export default {
  footer: {
    pageMeta: true,     // Enable page-level metadata footer
    created: true,      // Show page initial introduction date (from Git or frontmatter)
    updated: true,      // Show page last modified date (from Git or frontmatter)
    editLink: true,     // Automatic "Edit this page" link
    version: true,      // Show Docboot version in site footer
    commit: false,      // Show short commit SHA in site footer
    buildDuration: false, // Show compilation duration in site footer
    branding: true,     // Show "Built with Docboot" branding
    links: [
      { label: "GitHub", href: "https://github.com/litepacks/docboot" },
      { label: "npm", href: "https://www.npmjs.com/package/docboot" }
    ]
  }
};

---
title: State Management
created: 2026-08-12
updated: 2026-08-29
editLink: false
---

export default {
  redirects: {
    "/old-api": "/reference/api",
    "/guide/install": "/getting-started/installation",
    "/config": "/reference/configuration",
    "/docs/search": "/guide/search#configuration",
    "/legacy-site": "https://legacy.example.com"
  }
};

---
title: Build Cache
aliases:
  - /cache
  - /incremental-cache
redirectFrom:
  - /legacy-cache-v1
keywords:
  - caching
  - multi-tier
---