Project IDX を使用すると、コードベースを初めて利用するユーザーが開発環境をセットアップして生産性を高める手順を簡素化できます。
たとえば、
他のコントリビューターと協力して作業している場合は、プロジェクトに合わせて正確に環境をカスタマイズし、
.idx/dev.nixファイルをプロジェクトの Git リポジトリに commit できます。そうすれば、チームメンバーが Git リポジトリを IDX にインポートすると、新しいワークスペースには、同じシステム パッケージ、IDE 拡張機能、スターター スクリプトなどを含む、あなたのワークスペースとまったく同じ構成が組み込まれます。他のユーザーが使用できるようにフレームワークまたはライブラリを構築する場合は、サンプルコード リポジトリに
.idx/dev.nixファイルを含めることができます。これにより、ユーザーがサンプルを IDX にインポートするときに、環境設定をスキップしてフレームワークをすぐに試すことができます。ユーザー向けのカスタマイズ可能な開始点として、独自のカスタム テンプレートを作成することもできます。
環境のカスタマイズに問題がなければ、プロジェクトの README.md ファイルなど、ドキュメントに [IDX で開く] ボタンを追加することで、他のユーザーがより簡単にプロジェクトを IDX にインポートできるようになります。
一般的な「IDX で開く」エントリ ポイント
[IDX で開く] ボタンで使用できる URL パターンは次のとおりです。
Git リポジトリの URL が事前入力された Git リポジトリのインポート フローにリンクするには、次の URL パターンを使用します。
https://idx.google.com/import?url=https://github.com/my-org/my-repo現時点では、GitHub リポジトリのみがサポートされています（限定公開と公開の両方）。
事前定義のワークスペース テンプレートにリンクするには、IDX の [テンプレート] ページで探しているテンプレートを見つけて URL をコピーします。この URL は次の URL パターンである必要があります。
https://idx.google.com/new/geminiテンプレートの GitHub URL が事前入力されたカスタム テンプレートにリンクするには、次の URL パターンを使用します。
https://idx.google.com/new?template=https://github.com/my-org/my-template
[IDX で開く] ボタンを追加する
このツールを使用して、IDX ボタンの HTML を生成します。