Global Configuration

Use a config.json file to define project‑wide metadata for your documentation site. These values are applied to every generated page unless a page overrides them in its own frontmatter.

config.json

Place a config.json at your project root (the same folder where you execute npx doccupine) to define global metadata for your documentation site.

{
  "name": "Doccupine",
  "description": "Doccupine is a free and open-source documentation platform. Write MDX, get a production-ready site with AI chat, built-in components, and an MCP server - in one command.",
  "icon": "https://docs.doccupine.com/favicon.ico",
  "image": "https://docs.doccupine.com/preview.png",
  "url": "https://docs.example.com"
}

Fields

All fields are optional. Doccupine uses sensible defaults when a field is not set.

• name: The primary name of your documentation website. Displayed in the site title and used in various UI elements.
• description: A concise summary of your project, used in site metadata (e.g., HTML meta description) and social previews when not overridden.
• icon: The favicon for your site. You can provide a full URL or a relative path to an asset in your project.
• image: The Open Graph image used when links to your docs are shared on social platforms. Accepts a full URL or a relative path.
• url: The public URL of your deployed site. Used as the base URL for sitemap.xml and robots.txt. When omitted, no sitemap is generated. Can be overridden at deploy time with the NEXT_PUBLIC_SITE_URL environment variable.

Per-page overrides

Any page can override global values by defining the matching key in its frontmatter. When present, the page's value takes precedence over config.json for that page only.

Example frontmatter in an .mdx file:

---
title: "My Feature"
description: "A focused description just for this page."
name: "My Product Docs"
icon: "/custom-favicon.ico"
image: "/custom-preview.png"
date: "2026-02-19"
category: "Guides"
---