クイックスタート

5分以内に素晴らしいドキュメントの構築を開始

開発環境のセットアップ

ドキュメントをローカルで更新し、パブリックにデプロイする方法を学びましょう。

編集とプレビュー

ドキュメントをローカルにクローン

オンボーディングプロセス中に、ドキュメントコンテンツを含むGitHubリポジトリを作成しました。このリポジトリは、 ダッシュボードで見つけることができます。リポジトリを ローカルにクローンするには、ターミナルで以下の 手順 に従ってください。

変更のプレビュー

プレビューは、変更が意図した通りに表示されることを確認するのに役立ちます。これらの変更をローカルで レンダリングするためのコマンドラインインターフェースを構築しました。1. 次のコマンドで Mintlify CLIをインストールして、 ドキュメント変更をローカルでプレビューします： npm i -g mintlify 2. ドキュメントのルート（mint.jsonがある場所）で次のコマンドを実行します： mintlify dev

変更のデプロイ

GitHub アプリのインストール

私たちのGitHubアプリは、変更を自動的にドキュメントサイトにデプロイするため、 デプロイメントを自分で管理する必要はありません。インストールリンクは ダッシュボードで見つけることができます。ボットが 正常にインストールされると、リポジトリのコミットハッシュの横にチェックマークが表示されるはずです。

変更をプッシュ

ドキュメントサイトで変更を更新するために、 変更をGitにコミットしてプッシュ してください。プッシュしてもGitHubアプリが変更を正常にデプロイしていない場合は、 ダッシュボードでドキュメントを手動で更新することもできます。

ドキュメントの更新

MDX構文とReactコンポーネントを使用して、ファイルに直接コンテンツを追加します。私たちのコンポーネントのいずれかを使用することも、独自のコンポーネントを構築することもできます。

ドキュメントのスタイリング

パーソナライズされたブランディングでドキュメントに華やかさを加えます。

APIエンドポイントの追加

OpenAPI仕様を実装し、APIユーザーインタラクションを有効にします。

アナリティクスの統合

ドキュメントとのユーザーインタラクションから洞察を得ます。

カスタムドメインでのホスティング

自社ウェブサイトのサブドメインでドキュメントを維持します。