Aggiungi un pulsante "Apri in IDX"

Con Project IDX puoi semplificare i passaggi per chi non conosce il tuo codebase per configurare il proprio ambiente di sviluppo e aumentare la produttività.

Ad esempio,

  • Se stai lavorando in team con altri collaboratori, puoi personalizzare il tuo ambiente in base al progetto ed eseguire il commit del file .idx/dev.nix nel repository Git del progetto. In questo modo, quando un membro del team importa il tuo repository Git in IDX, la sua nuova area di lavoro avrà la stessa configurazione della tua, completa degli stessi pacchetti di sistema, estensioni IDE, script iniziali e altro ancora.

  • Se stai creando un framework o una libreria che altri utenti possono utilizzare, puoi includere un file .idx/dev.nix nei tuoi repository di codice di esempio, in modo che quando un utente importa i tuoi esempi in IDX, possa saltare la configurazione dell'ambiente e passare direttamente alla prova del tuo framework. Puoi anche creare un tuo modello personalizzato come punto di partenza "guidato" e personalizzabile per i tuoi utenti.

Quando sei soddisfatto delle personalizzazioni del tuo ambiente, puoi rendere ancora più semplice per gli altri importare il tuo progetto in IDX aggiungendo un pulsante "Apri in IDX" alla tua documentazione, ad esempio il file README.md del tuo progetto.

Punti di ingresso comuni "Apri in IDX"

Sono disponibili diversi pattern URL per un pulsante "Apri in IDX" disponibile:

  • Per collegarti al flusso di importazione di un repository Git, precompilato con l'URL del tuo repository Git, utilizza questo pattern URL:

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

    Al momento sono supportati solo i repository GitHub (privati e pubblici).

  • Per creare un link a un modello di area di lavoro predefinito, trova il modello che stai cercando nella pagina Modelli di IDX e copia il relativo URL, che dovrebbe avere questo pattern URL:

    https://idx.google.com/new/gemini
    
  • Per creare un link a un modello personalizzato, precompilato con l'URL GitHub del tuo modello, utilizza questo pattern URL:

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

Aggiungi un pulsante "Apri in IDX"

Utilizza questo strumento per generare il codice HTML di un pulsante IDX: