概要

レイアウト、強調、API ドキュメント、ナビゲーションのためのコンポーネントライブラリ。

Mintlify は、ドキュメントページ用の組み込み MDX コンポーネントを提供します。これらのコンポーネントを使って、コンテンツを構造化し、重要な情報に注意を向けさせ、API を文書化し、ナビゲーションを案内できます。

コンテンツを構造化する

タブ

関連するコンテンツを切り替え可能なタブ表示に整理します。

コードグループ

複数の言語でコード例を表示します。

ステップ

連続した手順を番号付き形式で表示します。

カラム

レスポンシブなレイアウトでコンテンツを横並びに配置します。

パネル

補足コンテンツ用のサイドバーパネルを作成します。

注目を集める

コールアウト

スタイル付きアラートで重要な情報を強調します。

バナー

ページ上部に目立つお知らせを表示します。

バッジ

インラインのラベルやステータス表示を追加します。

アップデート

新規または更新されたコンテンツを強調表示します。

フレーム

画像やコンテンツに枠線やスタイルを追加します。

ツールチップ

ホバー時に追加情報を表示します。

コンテンツの表示と非表示

アコーディオン

コンテンツを段階的に開示するための展開可能なセクションです。

エクスパンダブル

必要に応じて詳細なコンテンツを表示・非表示にします。

ビュー

コンテキストに基づいてコンテンツを条件付きで表示します。

API をドキュメント化する

フィールド

パラメータやプロパティの定義を表示します。

レスポンス

API レスポンスの構造やフィールドを文書化します。

リクエストとレスポンスの例を並べて表示します。

他のページへのリンク

カード

カスタマイズ可能なコンテナとアイコンでコンテンツを強調表示します。

タイル

クリック可能なタイルのグリッドでコンテンツを表示します。

視覚的な文脈を追加する

アイコン

Lucide アイコンライブラリを使って視覚的な指標を追加します。

Mermaid 図

フローチャート、シーケンス図などを作成します。

カラー

16 進数値付きのカラースウォッチを表示します。