グローバル設定

すべての Mintlify サイトには、コア設定を含む docs.json ファイルが必要です。下記のプロパティについて詳しく学びましょう。

プロパティ

namestringrequired

プロジェクト名。グローバルタイトルとして使用されます。

例：mintlify

navigationNavigation[]required

グループ内のすべてのページを含むグループの配列

Navigation

groupstring

グループの名前。

例：Settings

pagesstring[]

ページとして使用される Markdown ファイルへの相対パス。

例：["customization", "page"]

logostring or object

ロゴ画像へのパス、または「ライト」モードと「ダーク」モードのロゴ画像へのパスを含むオブジェクト

Logo

lightstring

ライトモードのロゴへのパス

darkstring

ダークモードのロゴへのパス

hrefstring

ロゴをクリックした場合のリンク先

faviconstring

favicon 画像へのパス

colorsColors

グローバルテーマの16進数カラーコード

Colors

primarystringrequired

プライマリカラー。ライトモードで最も頻繁に使用され、ハイライトコンテンツ、セクションヘッダー、アクセントに使用されます

lightstring

ダークモード用のプライマリカラー。ダークモードで最も頻繁に使用され、ハイライトコンテンツ、セクションヘッダー、アクセントに使用されます

darkstring

重要なボタン用のプライマリカラー

backgroundobject

ライトモードとダークモード両方の背景色

Object

lightstringrequired

ライトモードの背景の16進数カラーコード

darkstringrequired

ダークモードの背景の16進数カラーコード

topbarLinksTopbarLink[]

トップバーに含めたいリンクの name と url の配列

TopbarLink

namestring

ボタンの名前。

例：Contact us

urlstring

ボタンをクリックしたときの URL。例：https://mintlify.com/docs

topbarCtaButtonCall to Action

Topbar Call to Action

type"link" or "github"

link はボタンを表示します。GitHub は提供された URL からリポジトリ情報を表示します（GitHub スター数を含む）。

urlstring

link の場合：ボタンがリンクする URL。

github の場合：GitHub 情報を読み込むリポジトリへのリンク。

namestring

ボタン内のテキスト。type が link の場合のみ必須です。

versionsstring[]

バージョン名の配列。ナビゲーションバーのドロップダウンで異なるバージョンのドキュメントを表示したい場合のみ使用します。

anchorsAnchor[]

アンカーの配列。icon、color、url を含みます。

Anchor

iconstring

アンカーを表示するために使用される Font Awesome アイコン。

例：comments

namestring

アンカーラベルの名前。

例：Community

urlstring

どのページがアンカーに含まれるかを示す URL の先頭。通常はページを配置しているフォルダの名前です。

colorstring

アンカーアイコン背景の16進数カラー。from と to のプロパティがそれぞれ16進数カラーであるオブジェクトを渡すと、グラデーションにすることもできます。

versionstring

正しいドキュメントバージョンが選択されるまでアンカーを非表示にしたい場合に使用します。

isDefaultHiddenboolean

その中のドキュメントに直接リンクするまでアンカーを非表示にしたい場合は true を渡します。

iconTypestring

以下のいずれか：「brands」、「duotone」、「light」、「sharp-solid」、「solid」、「thin」

topAnchorObject

最上位のアンカーのデフォルト設定をオーバーライドします。

Object

namestring

最上位のアンカーの名前

iconstring

Font Awesome アイコン。

iconTypestring

以下のいずれか：「brands」、「duotone」、「light」、「sharp-solid」、「solid」、「thin」

tabsTabs[]

ナビゲーションタブの配列。

Tabs

namestring

タブラベルの名前。

urlstring

どのページがタブに含まれるかを示す URL の先頭。通常はページを配置しているフォルダの名前です。

apiAPI

API 設定の構成。API ページの詳細については API Components を参照してください。

API

baseUrlstring

すべての API エンドポイントのベース URL。baseUrl が配列の場合、ユーザーが切り替え可能な複数のベース URL オプションが有効になります。

authAuth

Auth

method"bearer" | "basic" | "key"

すべての API エンドポイントに使用される認証戦略。

namestring

API プレイグラウンドで使用される認証パラメータの名前。

method が basic の場合、フォーマットは [usernameName]:[passwordName] です。

inputPrefixstring

認証入力フィールドのプレフィックスとして設計されたデフォルト値。

例：AuthKey の inputPrefix を設定すると、認証フィールドのデフォルト入力結果が AuthKey として継承されます。

playgroundPlayground

API プレイグラウンドの設定

Playground

mode"show" | "simple" | "hide"

プレイグラウンドが表示される、非表示、または追加のユーザーインタラクティブなしでエンドポイントのみを表示する（simple）かを指定します。

詳細についてはプレイグラウンドガイドを参照してください。

maintainOrderboolean

このフラグを有効にすると、OpenAPI ページのキー順序が OpenAPI ファイルで定義されているキー順序と一致します。

警告

この動作は間もなくデフォルトで有効になります。その時点で、このフィールドは非推奨になります。

openapistring | string[]

OpenAPI ファイルを指す URL または相対パスの文字列、または文字列の配列。

例：

"openapi": "https://example.com/openapi.json"

"openapi": "/openapi.json"

"openapi": ["https://example.com/openapi1.json", "/openapi2.json", "/openapi3.json"]

footerSocialsFooterSocials

ソーシャルメディアアカウントのオブジェクト。キー:プロパティのペアは、ソーシャルメディアプラットフォームとアカウント URL を表します。

例：

{
  "x": "https://x.com/mintlify",
  "website": "https://mintlify.com"
}

FooterSocials

[key]string

以下のいずれかの値：website、facebook、x、discord、slack、github、linkedin、instagram、hacker-news

例：x

propertystring

ソーシャルプラットフォームの URL。

例：https://x.com/mintlify

feedbackFeedback

フィードバックボタンを有効にする設定

Feedback

suggestEditboolean

ユーザーがプルリクエスト経由で編集を提案できるボタンを有効にします

raiseIssueboolean

ユーザーがドキュメントに関する issue を作成できるボタンを有効にします

modeToggleModeToggle

ダークモードトグルのカスタマイズ。

ModeToggle

default"light" or "dark"

新規ユーザーに常にライトモードまたはダークモードを表示する場合に設定します。設定しない場合は、ユーザーのオペレーティングシステムと同じモードがデフォルトになります。

isHiddenboolean

ダーク/ライトモードトグルを非表示にする場合は true に設定します。isHidden と default を組み合わせて、ドキュメントをライトモードまたはダークモードのみに強制できます。例：

"modeToggle": {
  "default": "dark",
  "isHidden": true
}

"modeToggle": {
  "default": "light",
  "isHidden": true
}

backgroundImagestring

すべてのページの背後に表示される背景画像。Infisical および FRPC の例を参照してください。