グローバル設定

Mintlifyは、mint.jsonファイルを使用してドキュメントの外観と操作性を完全に制御できます

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

プロパティ

name · string · required

プロジェクトの名前。グローバルタイトルに使用されます。

例: mintlify

navigation · Navigation[] · required

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

Show Navigation

group · string

グループの名前。

例: Settings

pages · string[]

ページとして機能するmarkdownファイルへの相対パス。

例: ["customization", "page"]

logo · string or object

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

Show Logo

light · string

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

dark · string

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

href · string · default: "/"

ロゴをクリックした際のリンク先

favicon · string

faviconイメージへのパス

colors · Colors

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

Show Colors

primary · string · required

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

light · string

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

dark · string

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

background · object

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

Show Object

light · string · required

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

dark · string · required

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

topbarLinks · TopbarLink[]

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

Show TopbarLink

name · string

ボタンの名前。

例: お問い合わせ

url · string

ボタンをクリックした際のurl。例: https://mintlify.com/docs

topbarCtaButton · Call to Action

Show Topbar Call to Action

type · "link" or "github" · default: "link"

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

url · string

linkの場合：ボタンのリンク先。

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

name · string

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

versions · string[]

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

anchors · Anchor[]

icon、color、urlを含むアンカーの配列。

Show Anchor

icon · string

アンカーを特徴づけるために使用されるFont Awesomeアイコン。

例: comments

name · string

アンカーラベルの名前。

例: コミュニティ

url · string

アンカーに含まれるページを示すURLの開始部分。一般的に、これはページを配置するフォルダの名前です。

color · string

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

version · string

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

isDefaultHidden · boolean · default: "false"

その内部のドキュメントに直接リンクするまでアンカーを隠したい場合はtrueを渡してください。

iconType · string · default: "duotone"

次のいずれか: “brands”, “duotone”, “light”, “sharp-solid”, “solid”, または “thin”

topAnchor · Object

最上位アンカーのデフォルト設定を上書きします。

Show Object

name · string · default: "ドキュメント"

最上位アンカーの名前

icon · string · default: "book-open"

Font Awesomeアイコン。

iconType · string · default: "duotone"

次のいずれか: “brands”, “duotone”, “light”, “sharp-solid”, “solid”, または “thin”

tabs · Tabs[]

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

Show Tabs

name · string

タブラベルの名前。

url · string

タブに含まれるページを示すURLの開始部分。一般的に、これはページを配置するフォルダの名前です。

api · API

API設定の構成。APIコンポーネントでAPIページについて詳しく学んでください。

Show API

baseUrl · string

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

auth · Auth

Show Auth

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

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

name · string

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

methodがbasicの場合、フォーマットは[usernameName]:[passwordName]でなければなりません

inputPrefix · string

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

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

playground · Playground

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

Show Playground

mode · "show" | "simple" | "hide" · default: "show"

プレイグラウンドが表示されているか、隠されているか、またはユーザーインタラクティビティを追加せずにエンドポイントのみを表示するsimpleかどうか

プレイグラウンドガイドで詳しく学んでください

maintainOrder · boolean

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

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

openapi · string | string[]

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

例:

絶対パス

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

footerSocials · FooterSocials

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

例:

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

Show FooterSocials

[key] · string

次の値のいずれか website, facebook, x, discord, slack, github, linkedin, instagram, hacker-news

例: x

property · string

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

例: https://x.com/mintlify

feedback · Feedback

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

Show Feedback

suggestEdit · boolean · default: "false"

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

raiseIssue · boolean · default: "false"

ユーザーがドキュメントについて問題を報告できるボタンを有効にします

modeToggle · ModeToggle

ダークモードトグルをカスタマイズします。

Show ModeToggle

default · "light" or "dark"

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

isHidden · boolean · default: "false"

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

ダークモードのみ

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

backgroundImage · string

すべてのページの背景に表示される背景画像。InfisicalとFRPCの例をご覧ください。