Mintlify Starter Kit

🚀 Mintlify オープンソースプロジェクトスタートキット

Mintlifyのオープンソースプロジェクトスタートキットを複製するには、このテンプレートを使用 をクリックしてください。このキットには以下のサンプルが含まれています：

• ガイドページ
• ナビゲーション設定
• カスタム設定
• APIリファレンスドキュメント
• 一般的なコンポーネントの使用例

🚀 クイックスタート

開発ガイド

Mintlify CLI をインストールすると、ローカルでドキュメントの変更をプレビューできます。インストールコマンドは次の通りです：

npm i -g mintlify

ドキュメントのルートディレクトリ（docs.json が含まれるフォルダ）で以下のコマンドを実行して、ローカル開発サーバーを起動します：

mintlify dev

変更の公開

私たちのGitHubアプリをインストールすると、リポジトリからのデプロイまで自動的に同期されます。デフォルトブランチの変更をリポジトリにプッシュすると、アプリが自動的に本番環境にデプロイします。インストールリンクはコントロールパネルで確認してください。

🔧 技術詳細

一般的な問題の解決策

• ローカルで mintlify dev が実行できない場合 - mintlify install を実行して依存関係を再インストールしてください。
• ページが404エラーで読み込まれる場合 - docs.json を含むフォルダで実行していることを確認してください。