Skip to main content

クイックスタート

5分で優れたドキュメント作成を始めましょう
1 min read

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

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

編集とプレビュー#

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

オンボーディングの際に、あなたの GitHub 上にドキュメントコンテンツを含むリポジトリを作成しました。リポジトリは ダッシュボード から確認できます。ローカルにクローンするには、ターミナルで こちらの手順 に従ってください。

変更をプレビューする

プレビューすると、変更が意図どおりに表示されているか確認できます。ローカルで変更をレンダリングするためのコマンドラインインターフェースを用意しています。1. 次のコマンドで Mintlify CLI をインストールし、ローカルでドキュメントの変更をプレビューします: npm i -g mintlify 2. ドキュメントのルート(mint.json がある場所)で次のコマンドを実行します: mintlify dev

変更をデプロイする#

GitHub アプリをインストールする

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

変更をプッシュする

ドキュメントサイトを更新するには、 変更をコミットして Git にプッシュ してください。プッシュ後に GitHub アプリでデプロイが確認できない場合は、 ダッシュボードから手動でドキュメントを更新できます。

ドキュメントを更新#

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