docs.json ファイルを使うと、Markdown ファイルの集合を、ナビゲーション可能でカスタマイズされたドキュメントサイトに変換できます。必須のこの設定ファイルは、スタイル、ナビゲーション、連携機能などを管理します。ドキュメントの設計図と考えてください。 docs.json の設定は、すべてのページに対してグローバルに適用されます。

​
docs.json の設定

はじめるには、theme、name、colors.primary、navigation を指定するだけで十分です。その他のフィールドは任意で、ドキュメントの要件に応じて後から追加できます。 最良の編集体験のために、docs.json ファイルの先頭にスキーマ参照を記載してください。これにより、ほとんどのコードエディタでオートコンプリート、検証、ツールチップが有効になります。 
{
  "$schema": "https://mintlify.com/docs.json",
  "theme": "mint",
  "name": "Your Docs",
  "colors": {
    "primary": "#ff0000"
  },
  "navigation": {
    // ナビゲーション構造
  }
  // そのほかの設定
}

​
リファレンス

このセクションでは、docs.json ファイルのリファレンスを全て掲載します。

​
カスタマイズ

​
theme
required
サイトのレイアウトテーマ。次のいずれか: mint, maple, palm, willow, linden, almond, aspen。詳しくはThemesを参照してください。
​
name
string
required
プロジェクト、組織、またはプロダクトの名称。
​
colors
object
required
ドキュメントで使用するカラー。テーマによって適用方法が異なります。primary だけを指定した場合、すべてのカラ要素にその色が使われます。
​
description
string
SEO と AI インデックス用のサイト説明。
ライトモードとダークモードの両方で使用するロゴ。
​
favicon
string or object
ファビコンファイルへのパス（拡張子を含む）。適切なサイズに自動リサイズされます。 単一ファイル、またはライト/ダークで別ファイルを指定できます。例: /favicon.png
​
thumbnails
object
ソーシャルメディアおよびページプレビュー向けのサムネイル設定。
​
styling
object
ビジュアルスタイリングの設定。
​
icons
object
アイコンライブラリの設定。
​
fonts
object
ドキュメントのフォント設定。デフォルトのフォントは Inter です。
​
appearance
object
ライト/ダークモードの切り替え設定。
​
background
object
背景色と装飾の設定。

​
構造

​
navbar
object
ナビゲーションバーの項目。
​
navigation
object
required
コンテンツのナビゲーション構造。
​
interaction
object
ナビゲーション要素のユーザー操作設定。
​
footer
object
フッターのコンテンツとソーシャルメディアリンク。
​
banner
object
サイト全体のページ上部に表示されるバナー。
​
redirects
array of object
移動・名称変更・削除されたページのためのリダイレクト。
​
contextual
object
AI最適化されたコンテンツと統合のためのコンテキストメニュー。

​
API 設定

​
api
object
API ドキュメントとインタラクティブなプレイグラウンドの設定。
​
seo
object
SEO のインデックス設定。
​
search
object
検索の表示設定。

​
連携機能

​
integrations
object
サードパーティ連携

​
エラー

​
errors
object
エラー処理の設定。

​
例

docs.json
{
  "$schema": "https://mintlify.com/docs.json",
  "theme": "maple",
  "name": "Example Co.",
  "description": "Example Co. は、サンプルコンテンツとプレースホルダーテキストを提供する企業です。",
  "colors": {
    "primary": "#3B82F6",
    "light": "#F8FAFC",
    "dark": "#0F172A"
  },
  "navigation": {
    "dropdowns": [
      {
        "dropdown": "ドキュメント",
        "icon": "book",
        "description": "Example Co. のプロダクトの使い方",
        "groups": [
          {
            "group": "はじめに",
            "pages": [
              "index",
              "quickstart"
            ]
          },
          {
            "group": "カスタマイズ",
            "pages": [
              "settings",
              "users",
              "features"
            ]
          },
          {
            "group": "請求",
            "pages": [
              "billing/overview",
              "billing/payments",
              "billing/subscriptions"
            ]
          }
        ]
      },
      {
        "dropdown": "変更履歴",
        "icon": "history",
        "description": "更新内容と変更点",
        "pages": [
          "changelog"
        ]
      }
    ]
  },
  "logo": {
    "light": "/logo-light.svg",
    "dark": "/logo-dark.svg",
    "href": "https://example.com"
  },
  "navbar": {
    "links": [
      {
        "label": "コミュニティ",
        "href": "https://example.com/community"
      }
    ],
    "primary": {
      "type": "button",
      "label": "はじめる",
      "href": "https://example.com/start"
    }
  },
  "footer": {
    "socials": {
      "x": "https://x.com/example",
      "linkedin": "https://www.linkedin.com/company/example",
      "github": "https://github.com/example",
      "slack": "https://example.com/community"
    },
    "links": [
      {
        "header": "リソース",
        "items": [
          {
            "label": "導入事例",
            "href": "https://example.com/customers"
          },
          {
            "label": "エンタープライズ",
            "href": "https://example.com/enterprise"
          },
          {
            "label": "プレビューのリクエスト",
            "href": "https://example.com/preview"
          }
        ]
      },
      {
        "header": "会社情報",
        "items": [
          {
            "label": "採用情報",
            "href": "https://example.com/careers"
          },
          {
            "label": "ブログ",
            "href": "https://example.com/blog"
          },
          {
            "label": "プライバシーポリシー",
            "href": "https://example.com/legal/privacy"
          }
        ]
      }
    ]
  },
  "integrations": {
    "ga4": {
      "measurementId": "G-XXXXXXXXXX"
    },
    "koala": {
      "publicApiKey": "pk_example_key_123"
    },
    "telemetry": {
      "enabled": true
    },
    "cookies": {
      "key": "example_cookie_key",
      "value": "example_cookie_value"
    }
  },
  "contextual": {
    "options": [
      "copy",
      "view",
      "chatgpt",
      "claude"
    ]
  },
  "errors": {
    "404": {
      "redirect": false,
      "title": "見つかりません",
      "description": "この _ページ_ にいったい何が**起きた**のでしょう？"
    }
  }
}

​
mint.json からのアップグレード

ドキュメントプロジェクトで非推奨の mint.json を使用している場合は、次の手順に従って docs.json にアップグレードしてください。
1

CLI をインストールまたは更新する

まだ CLI をインストールしていない場合は、インストールしてください:
npm i -g mint
すでに CLI をインストール済みの場合は、最新バージョンであることを確認してください:
mint update
2

docs.json ファイルを作成する

ドキュメントのリポジトリで次を実行します:
mint upgrade
このコマンドは、既存の mint.json から docs.json を生成します。生成されたファイルを見直し、すべての設定が正しいことを確認してください。
3

mint.json ファイルを削除する

docs.json が正しく構成されていることを確認したら、古い mint.json ファイルは安全に削除できます。