有了 Project IDX,您就能為程式碼集的新成員簡化相關步驟,協助設定開發環境及提升工作效率。
比如
如果您正在與其他貢獻者合作,可以針對專案精確自訂環境,然後將
.idx/dev.nix
檔案提交至專案的 Git 存放區。這樣一來,當團隊成員在 IDX 中匯入 Git 存放區時,他們的新工作區就會擁有與您的設定完全相同,並以相同的系統套件、IDE 擴充功能、範例程式碼等項目完成作業。如果您正在建構架構或程式庫供他人使用,可以在程式碼範例存放區中加入
.idx/dev.nix
檔案,這樣當使用者將範例匯入 IDX 時,他們可以略過環境設定,直接嘗試您的架構。您甚至可以建構自己的自訂範本,做為可明確自訂的起點,供使用者自訂。
完成環境自訂設定後,只要在說明文件 (例如專案的 README.md
檔案) 中新增「Open in IDX」按鈕,就能輕鬆將專案匯入 IDX。
常見的「在 IDX 中開啟」進入點
「在 IDX 中開啟」按鈕可用下列幾種網址模式:
如要連結至「匯入 Git 存放區」流程 (已預先填入您的 Git 存放區網址),請使用下列網址模式:
https://idx.google.com/import?url=https://github.com/my-org/my-repo
目前僅支援 GitHub 存放區 (包括私人與公開存放區)。
如要連結至預先定義的工作區範本,請在 IDX 的「Templates」頁面中尋找所需的範本,然後複製其網址 (應遵循以下網址模式):
https://idx.google.com/new/gemini
如要連結至已預先填入範本 GitHub 網址的自訂範本,請使用下列網址模式:
https://idx.google.com/new?template=https://github.com/my-org/my-template
新增「在 IDX 中開啟」按鈕
請使用這項工具產生 IDX 按鈕的 HTML: