添加“在 IDX 中打开”按钮

借助 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: