Docs

🚀 Mintlify Starter Kit

このスターターキットを使用すると、ドキュメントをデプロイし、カスタマイズできる状態にすることができます。

このリポジトリの上部にある緑色の Use this template ボタンをクリックして、Mintlifyのスターターキットをコピーします。このスターターキットには以下のような例が含まれています。

• ガイドページ
• ナビゲーション
• カスタマイズ
• APIリファレンスページ
• 人気のあるコンポーネントの使用

完全なクイックスタートガイドを参照

🚀 クイックスタート

📦 インストール

ドキュメントの変更をローカルでプレビューするには、Mintlify CLI をインストールします。インストールには、以下のコマンドを使用します。

npm i -g mint

docs.json があるドキュメントのルートディレクトリで以下のコマンドを実行します。

mint dev

http://localhost:3000 でローカルプレビューを確認できます。

📤 変更の公開

リポジトリからの変更をデプロイ先に反映させるには、ダッシュボード からGitHubアプリをインストールします。デフォルトブランチにプッシュした後、変更は自動的に本番環境にデプロイされます。

💻 使用例

トラブルシューティング

• 開発環境が起動しない場合：mint update を実行して、CLIの最新バージョンを使用していることを確認します。
• ページが404エラーで表示される場合：有効な docs.json があるフォルダで実行していることを確認します。

リソース

• Mintlifyドキュメント
• Mintlifyコミュニティ