メインコンテンツへスキップ

​
3ステップで開始

ドキュメントサイトをローカルで実行し、最初のカスタマイズを行いましょう。

​
ステップ1: ローカル環境のセットアップ

オンボーディングプロセス中に、ドキュメントコンテンツを含むGitHubリポジトリを作成したはずです（まだ持っていない場合）。このリポジトリへのリンクは、ダッシュボードで見つけることができます。リポジトリをローカルにクローンして、ドキュメントの変更とプレビューを行えるようにするには、GitHubドキュメントのリポジトリをクローンするガイドに従ってください。
  1. Mintlify CLIをインストールします: npm i -g mint
  2. ドキュメントのディレクトリに移動し、mint dev を実行します
  3. http://localhost:3000 を開いて、ドキュメントがライブで表示されるのを確認しましょう！
ファイルを編集すると、プレビューは自動的に更新されます。

​
ステップ2: 変更をデプロイする

ダッシュボードからMintlify GitHubアプリをインストールします。GitHubアプリは変更を自動的にドキュメントサイトにデプロイするため、自分でデプロイを管理する必要はありません。
最初の変更として、ドキュメントサイトの名前と色を更新してみましょう。
  1. エディタで docs.json を開きます。
  2. "name" フィールドをプロジェクト名に変更します。
  3. "colors" をブランドに合わせて更新します。
  4. 保存すると、http://localhost:3000 で即座に変更を確認できます。
プライマリカラーを変更して、すぐに違いを確認してみましょう！

​
ステップ3: 公開する

  1. 変更をコミットしてプッシュします。
  2. ドキュメントが更新され、すぐに公開されます！

​
次のステップ

ドキュメントが実行されたので、以下の主要な機能を試してみましょう：

コンテンツの記述

MDX構文を学び、ドキュメントの作成を開始しましょう。

スタイルのカスタマイズ

ドキュメントをブランドに完璧に合わせましょう。

コードサンプルの追加

構文強調表示されたコードブロックを含めましょう。

APIドキュメント

OpenAPI仕様からAPIドキュメントを自動生成します。
お困りですか？ フルドキュメントを参照するか、コミュニティに参加してください。