Skip to main content

​
開発環境のセットアップ

ローカルでドキュメントを更新し、公開にデプロイする方法を学びます。

​
編集とプレビュー

オンボーディングの際に、あなたの GitHub 上にドキュメントコンテンツを含むリポジトリを作成しました。リポジトリは ダッシュボード から確認できます。ローカルにクローンするには、ターミナルで こちらの手順 に従ってください。
プレビューすると、変更が意図どおりに表示されているか確認できます。ローカルで変更をレンダリングするためのコマンドラインインターフェースを用意しています。1. 次のコマンドで Mintlify CLI をインストールし、ローカルでドキュメントの変更をプレビューします: npm i -g mintlify 2. ドキュメントのルート（mint.json がある場所）で次のコマンドを実行します: mintlify dev

​
変更をデプロイする

当社の GitHub アプリは、ドキュメントサイトへの変更を自動的にデプロイします。手動でデプロイを管理する必要はありません。インストール用のリンクは ダッシュボードにあります。ボットのインストールが完了すると、リポジトリのコミットハッシュの横にチェックマークが表示されます。
ドキュメントサイトを更新するには、 変更をコミットして Git にプッシュ してください。プッシュ後に GitHub アプリでデプロイが確認できない場合は、 ダッシュボードから手動でドキュメントを更新できます。

​
ドキュメントを更新

MDX構文とReactコンポーネントで、ファイル内に直接コンテンツを追加できます。用意されたコンポーネントを使うことも、自作することも可能です。

ドキュメントのスタイル設定

ブランディングをカスタマイズして、ドキュメントに個性を加えましょう。

APIエンドポイントの追加

OpenAPI仕様を取り込み、APIのインタラクションを有効化します。

アナリティクスの統合

ドキュメント上のユーザー行動からインサイトを得ましょう。

カスタムドメインでホスト

自身のウェブサイトのサブドメインでドキュメントを公開できます。