Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/sorgm/data-architecture-docs/llms.txt

Use this file to discover all available pages before exploring further.

Every Mintlify site needs a docs.json file with core configuration settings. This file controls everything from your site’s appearance to navigation structure.

​
Essential Configuration

​
Project Name

The name field sets your project’s global title, appearing in the browser tab and site header. 
{
  "name": "Data Architecture"
}

​
Theme Selection

Choose from Mintlify’s built-in themes. The mint theme provides a clean, modern look. 
{
  "theme": "mint"
}

​
Branding

​
Logo Configuration

Configure your logo for light and dark modes. Logos can link to custom URLs when clicked. 
{
  "logo": {
    "light": "/logo/light.svg",
    "dark": "/logo/dark.svg",
    "href": "/"
  }
}
Logo images should be SVG format for best quality at all sizes. Place logo files in your /public directory or use absolute URLs.

​
Favicon

Set a custom favicon that appears in browser tabs and bookmarks. 
{
  "favicon": "/favicon.svg"
}

​
Color Customization

​
Theme Colors

Define your brand colors for light and dark modes. These colors appear in headings, links, buttons, and accents throughout your documentation. 
{
  "colors": {
    "primary": "#16A34A",
    "light": "#07C983",
    "dark": "#15803D"
  }
}
  • primary: Main accent color for light mode
  • light: Accent color for dark mode
  • dark: Color for important buttons and CTAs
  • background: Optional custom background colors

​
Mode Toggle

Control the dark mode toggle behavior and default appearance.
Default behavior matches the user’s operating system preference.
{
  "modeToggle": {
    "default": "system"
  }
}
Add navigation links to your top bar for support, contact, or external resources. 
{
  "navbar": {
    "links": [
      {
        "label": "Support",
        "href": "mailto:hi@mintlify.com"
      }
    ]
  }
}

​
Primary CTA Button

Add a prominent call-to-action button in your navbar. 
{
  "navbar": {
    "primary": {
      "type": "button",
      "label": "Dashboard",
      "href": "https://dashboard.mintlify.com"
    }
  }
}
The GitHub button type automatically displays your repository star count and links to your repo.
Add social media links to your footer for community engagement. 
{
  "footer": {
    "socials": {
      "x": "https://x.com/mintlify",
      "github": "https://github.com/mintlify",
      "linkedin": "https://linkedin.com/company/mintlify"
    }
  }
}
Supported platforms include:
  • website - Your company website
  • x - X (formerly Twitter)
  • github - GitHub repository
  • linkedin - LinkedIn company page
  • discord - Discord server
  • slack - Slack community
  • facebook - Facebook page
  • instagram - Instagram account
  • hacker-news - Hacker News profile

​
Advanced Features

​
Anchors

Create navigational anchors for major sections with custom icons and colors. 
{
  "navigation": {
    "global": {
      "anchors": [
        {
          "anchor": "Documentation",
          "href": "https://mintlify.com/docs",
          "icon": "book-open-cover"
        },
        {
          "anchor": "Blog",
          "href": "https://mintlify.com/blog",
          "icon": "newspaper"
        }
      ]
    }
  }
}
Icons use Font Awesome icon names. The default icon type is “duotone” but you can specify others like “solid”, “brands”, or “light”.

​
Contextual Actions

Enable contextual actions that appear when users select text on your documentation pages. 
{
  "contextual": {
    "options": [
      "copy",
      "view",
      "chatgpt",
      "claude",
      "perplexity",
      "mcp",
      "cursor",
      "vscode"
    ]
  }
}
This lets users quickly copy text, open it in AI tools, or view it in their editor.

​
Feedback Buttons

Enable user feedback options for suggesting edits or raising issues. 
{
  "feedback": {
    "suggestEdit": true,
    "raiseIssue": true
  }
}
These buttons require your documentation to be connected to a GitHub repository for pull requests and issues.

​
Background Image

Add a custom background image that appears behind all pages. 
{
  "backgroundImage": "/background.png"
}

​
Complete Example

Here’s a fully configured docs.json file combining all major settings: 
{
  "$schema": "https://mintlify.com/docs.json",
  "name": "Data Architecture",
  "theme": "mint",
  "logo": {
    "light": "/logo/light.svg",
    "dark": "/logo/dark.svg"
  },
  "favicon": "/favicon.svg",
  "colors": {
    "primary": "#16A34A",
    "light": "#07C983",
    "dark": "#15803D"
  },
  "navbar": {
    "links": [
      {
        "label": "Support",
        "href": "mailto:hi@mintlify.com"
      }
    ],
    "primary": {
      "type": "button",
      "label": "Dashboard",
      "href": "https://dashboard.mintlify.com"
    }
  },
  "footer": {
    "socials": {
      "x": "https://x.com/mintlify",
      "github": "https://github.com/mintlify",
      "linkedin": "https://linkedin.com/company/mintlify"
    }
  },
  "contextual": {
    "options": ["copy", "view", "chatgpt", "claude"]
  },
  "modeToggle": {
    "default": "system"
  }
}

​
Next Steps

Navigation

Learn how to structure your documentation navigation

Markdown

Explore Mintlify’s markdown syntax and components

Build docs developers (and LLMs) love

Get started for freeTalk to us