すべての Mintlify サイトには、コア設定が含まれた docs.json ファイルが必要です。以下の プロパティ で詳細を確認してください。
プロパティ
プロジェクトの名前。グローバルタイトルとして使用されます。例： mintlify
グループ内のすべてのページを含むグループの配列
ページとして機能する Markdown ファイルへの相対パス。例： ["customization", "page"]
ロゴ画像へのパス、または「ライト」モードと「ダーク」モードのロゴ画像へのパスを持つオブジェクト
グローバルテーマの 16 進数カラーコード
プライマリカラー。ライトモードでの強調表示されたコンテンツ、セクションヘッダー、アクセントに最も頻繁に使用されます。
ダークモードでのプライマリカラー。ダークモードでの強調表示されたコンテンツ、セクションヘッダー、アクセントに最も頻繁に使用されます。
トップバーに含めたいリンクの name と url の配列
ボタンをクリックした際の URL。例： https://mintlify.com/docs
type
"link" or "github"
デフォルト:"link"
link はボタンを表示します。 github は、提供された URL のリポジトリ情報（GitHub のスター数を含む）を表示します。
type が link の場合：ボタンのリンク先。type が github の場合：GitHub 情報を取得するリポジトリへのリンク。
ボタン内のテキスト。 type が link の場合のみ必須です。
バージョン名の配列。ナビゲーションバーのドロップダウンで、異なるバージョンのドキュメントを表示したい場合のみ使用してください。
アンカーの配列。 icon, color, url を含みます。
そのアンカーに含まれるページを示す URL の開始部分。通常は、ページを配置したフォルダの名前です。
アンカーアイコンの背景の 16 進数カラー。 from と to のプロパティ（それぞれ 16 進数カラー）を持つオブジェクトを渡すことで、グラデーションにすることもできます。
正しいドキュメントバージョンが選択されるまでアンカーを非表示にしたい場合に使用されます。
そのアンカー内のドキュメントへ直接リンクされるまでアンカーを非表示にしたい場合に true を渡します。
“brands”, “duotone”, “light”, “sharp-solid”, “solid”, “thin” のいずれか
最上部のアンカーのデフォルト設定を上書きします。
name
string
デフォルト:"Documentation"
最上部のアンカーの名前
“brands”, “duotone”, “light”, “sharp-solid”, “solid”, “thin” のいずれか
ナビゲーションタブの配列。
そのタブに含まれるページを示す URL の開始部分。通常は、ページを配置したフォルダの名前です。
API 設定の構成。API ページの詳細については、 API コンポーネント を参照してください。
すべての API エンドポイントのベース URL。 baseUrl が配列の場合、ユーザーが切り替え可能な複数のベース URL オプションが有効になります。
method
"bearer" | "basic" | "key"
すべての API エンドポイントで使用される認証戦略。
API プレイグラウンドで使用される認証パラメータの名前。メソッドが basic の場合、形式は [usernameName]:[passwordName] である必要があります。
認証入力フィールドのプレフィックスとして設計されたデフォルト値。例： inputPrefix が AuthKey の場合、認証フィールドのデフォルトの入力結果は AuthKey を継承します。
API プレイグラウンドの設定
mode
"show" | "simple" | "hide"
デフォルト:"show"
プレイグラウンドを表示するか、非表示にするか、またはユーザーの対話機能なしでエンドポイントのみを表示する simple にするか詳細は プレイグラウンドガイド を参照してください このフラグを有効にすると、OpenAPI ページ内のキーの順序が OpenAPI ファイルで定義されたキーの順序と一致するようになります。この動作はまもなくデフォルトで有効になり、その時点でこのフィールドは非推奨になります。
OpenAPI ファイルを指す URL または相対パスの文字列、または文字列の配列。例："openapi": "https://example.com/openapi.json"
ソーシャルメディアアカウントのオブジェクト。キー：プロパティのペアは、ソーシャルメディアプラットフォームとアカウント URL を表します。例：{
"x": "https://x.com/mintlify",
"website": "https://mintlify.com"
}
website, facebook, x, discord, slack, github, linkedin, instagram, hacker-news のいずれかの値例： x
ソーシャルプラットフォームへの URL。例： https://x.com/mintlify
フィードバックボタンを有効にするための設定
プルリクエストを介した編集提案をユーザーに許可するボタンを有効にします
ドキュメントに関する問題を報告するためのボタンを有効にします
ダークモードの切り替えをカスタマイズします。
新しいユーザーに常にライトモードまたはダークモードを表示したい場合に設定します。設定されていない場合、ユーザーのオペレーティングシステムと同じモードがデフォルトになります。
ダーク/ライトモードの切り替えを非表示にするには true に設定します。 isHidden と default を組み合わせて、ドキュメントにライトモードまたはダークモードのみを使用させることができます。例えば："modeToggle": {
"default": "dark",
"isHidden": true
}
