Добавьте параметр «Открыть в IDX»; кнопка

С помощью Project IDX вы можете упростить для новичков в вашей кодовой базе действия по настройке среды разработки и продуктивной работе.

Например,

  • Если вы работаете в команде с другими участниками , вы можете настроить среду именно для своего проекта, а затем зафиксировать файл .idx/dev.nix в репозитории Git вашего проекта. Таким образом, когда товарищ по команде импортирует ваш репозиторий Git в IDX, его новое рабочее пространство будет иметь ту же конфигурацию, что и ваше, с теми же системными пакетами, расширениями IDE, стартовыми скриптами и многим другим.

  • Если вы создаете платформу или библиотеку для использования другими, вы можете включить файл .idx/dev.nix в репозитории примеров кода, чтобы, когда пользователь импортирует ваши примеры в IDX, он мог пропустить настройку среды и сразу перейти к использованию. сразу приступить к опробованию вашего фреймворка. Вы даже можете создать свой собственный шаблон в качестве индивидуальной и настраиваемой отправной точки для ваших пользователей.

Когда вы будете довольны настройками своей среды, вы можете еще больше упростить импорт вашего проекта в IDX для других, добавив кнопку «Открыть в IDX» в вашу документацию, например, в файл README.md вашего проекта.

Распространенные точки входа «Открыть в IDX»

Для кнопки «Открыть в IDX» доступно несколько шаблонов URL-адресов:

  • Чтобы создать ссылку на поток импорта репозитория Git , предварительно заполненный URL-адресом вашего репозитория Git, используйте этот шаблон URL-адреса:

    https://idx.google.com/import?url=https://github.com/my-org/my-repo

    В настоящее время поддерживаются только репозитории GitHub (как частные, так и общедоступные).

  • Чтобы создать ссылку на предопределенный шаблон рабочей области , найдите нужный шаблон на странице «Шаблоны» в IDX и скопируйте его URL-адрес, который должен соответствовать следующему шаблону URL-адресов:

    https://idx.google.com/new/gemini

  • Чтобы создать ссылку на собственный шаблон , предварительно заполненный URL-адресом вашего шаблона GitHub, используйте этот шаблон URL-адреса: 

    https://idx.google.com/new?template=https://github.com/my-org/my-template

Добавьте кнопку «Открыть в IDX».

Используйте этот инструмент для создания HTML-кода для кнопки IDX: