Use this templateをクリックして、Mintlifyスターターキットをコピーしてください。このスターターキットには以下の例が含まれています:
- ガイドページ
- ナビゲーション
- カスタマイズ
- APIリファレンスページ
- 人気のあるコンポーネントの使用
ドキュメントの変更をローカルでプレビューするには、Mintlify CLIをインストールしてください。インストールするには、次のコマンドを使用します:
npm i -g mintlify
ドキュメントのルート(docs.jsonがある場所)で次のコマンドを実行します:
mintlify dev
リポジトリからデプロイメントへの変更を自動的に反映させるために、GitHubアプリをインストールしてください。デフォルトブランチにプッシュした後、変更は自動的に本番環境にデプロイされます。インストールするためのリンクはダッシュボードで見つけることができます。
- Mintlify devが動作しない場合 -
mintlify installを実行して依存関係を再インストールしてください。 - ページが404として読み込まれる場合 -
docs.jsonがあるフォルダで実行していることを確認してください。