Dodaj przycisk „Otwórz w IDX”

Dzięki Project IDX możesz uprościć proces konfigurowania środowiska programistycznego w bazie kodu dla nowych użytkowników.

Na przykład

  • Jeśli pracujesz w zespole z innymi twórcami, możesz dostosować środowisko dokładnie pod kątem swojego projektu, a następnie zatwierdzić plik .idx/dev.nix w repozytorium Git projektu. Dzięki temu, gdy inny członek zespołu zaimportuje Twoje repozytorium Git w IDX, jego nowy obszar roboczy będzie miał dokładnie taką samą konfigurację jak Twój, zawierający te same pakiety systemowe, rozszerzenia IDE, skrypty startowe i nie tylko.

  • Jeśli tworzysz platformę lub bibliotekę dla innych osób, możesz umieścić plik .idx/dev.nix w repozytoriach przykładowych kodu. Dzięki temu po zaimportowaniu przykładów do IDX użytkownik będzie mógł pominąć konfigurację środowiska i od razu wypróbować Twoją platformę. Możesz nawet utworzyć własny, niestandardowy szablon jako punkt wyjścia do dostosowania go do potrzeb użytkowników.

Gdy uznasz, że ustawienia środowiska są dla Ciebie zadowalające, możesz ułatwić innym importowanie projektu do IDX, dodając przycisk „Otwórz w IDX” do dokumentacji, np. do pliku README.md projektu.

Typowe punkty wejścia „Otwórz w IDX”

Dostępnych jest kilka wzorców adresów URL dla przycisku „Otwórz w IDX”:

  • Aby połączyć się z procesem importowania repozytorium Git, który został wstępnie wypełniony adresem URL repozytorium Git, użyj tego wzorca adresu URL:

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

    Obecnie obsługiwane są tylko repozytoria GitHub (prywatne i publiczne).

  • Aby utworzyć link do wstępnie zdefiniowanego szablonu obszaru roboczego, znajdź szukany szablon na stronie Szablony w IDX i skopiuj jego adres URL, który powinien być zgodny z tym wzorcem adresu URL:

    https://idx.google.com/new/gemini
    
  • Aby utworzyć link do szablonu niestandardowego, wypełnionego adresem URL szablonu na GitHubie, użyj tego wzorca adresu URL:

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

Dodawanie przycisku „Otwórz w IDX”

Użyj tego narzędzia, aby wygenerować kod HTML dla przycisku IDX: