添加“在 IDX 中打开”按钮

借助 Project IDX,您可以简化代码库新手的步骤 来设置开发环境并提高工作效率。

例如,

  • 如果您正在与其他贡献者共同合作,可以自定义 你的环境 然后将 .idx/dev.nix 文件提交到项目的 Git 代码库。 这样,当团队成员在 IDX 中导入您的 Git 代码库时,他们的 新工作区的配置与您的完全相同, 相同的系统软件包、IDE 扩展程序、起始脚本等。

  • 如果您要构建框架或库以供他人使用,可以 在示例代码库中添加 .idx/dev.nix 文件,以便在 当用户将您的样本导入 IDX 时,他们可以跳过环境 然后直接开始试用该框架您甚至可以构建 自定义模板 提供可自定义的起点

如果您对环境自定义设置感到满意,就可以 添加“在 IDX"按钮添加到您的文档,例如项目的 README.md 文件。

常见“在 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: