借助 Project IDX,您可以简化代码库新手设置开发环境并提高工作效率的步骤。
例如,
如果您正在与其他贡献者团队合作,则可以为项目精确自定义您的环境,然后将
.idx/dev.nix
文件提交到项目的 Git 代码库。这样,当团队成员在 IDX 中导入您的 Git 代码库时,他们的新工作区将具有与您的工作区完全相同的配置,并且包含相同的系统软件包、IDE 扩展程序、起始脚本等。如果您要构建框架或库供他人使用,则可以在示例代码库中添加一个
.idx/dev.nix
文件,这样一来,当用户将示例导入 IDX 时,他们可以跳过环境设置,直接试用您的框架。您甚至可以构建自己的自定义模板,将其作为用户自行定制的模板。
如果您对环境自定义设置感到满意,可以在文档(例如项目的 README.md
文件)中添加“在 IDX 中打开”按钮,让其他人更轻松地将项目导入 IDX。
常见的“在 IDX 中打开”入口点
“在 IDX 中打开”按钮可以使用多种网址格式:
如需链接到导入 Git 代码库流程(已预填充您的 Git 代码库网址),请使用以下网址格式:
https://idx.google.com/import?url=https://github.com/my-org/my-repo
目前仅支持 GitHub 代码库(私有和公共)。
如需链接到预定义工作区模板,请在 IDX 的模板页面中找到要查找的模板,并复制其网址,该网址应遵循以下网址格式:
https://idx.google.com/new/gemini
如需链接到预填充了模板的 GitHub 网址的自定义模板,请使用以下网址格式:
https://idx.google.com/new?template=https://github.com/my-org/my-template
添加“在 IDX 中打开”按钮
使用此工具为 IDX 按钮生成 HTML: