Ajouter un bouton "Ouvrir dans IDX"

Avec Project IDX, vous pouvez simplifier la procédure pour permettre à un nouvel utilisateur de votre codebase de configurer son environnement de développement et de gagner en productivité.

Par exemple :

  • Si vous travaillez en équipe avec d'autres contributeurs, vous pouvez personnaliser votre environnement avec précision en fonction de votre projet, puis valider votre fichier .idx/dev.nix dans le dépôt Git de votre projet. Ainsi, lorsqu'un coéquipier importe votre dépôt Git dans IDX, son nouvel espace de travail aura exactement la même configuration que le vôtre, avec les mêmes packages système, extensions IDE, scripts de démarrage, etc.

  • Si vous créez un framework ou une bibliothèque pour que d'autres personnes puissent les utiliser, vous pouvez inclure un fichier .idx/dev.nix dans vos dépôts d'exemples de code. Ainsi, lorsqu'un utilisateur importe vos exemples dans IDX, il peut ignorer la configuration de l'environnement et passer directement à l'essai de votre framework. Vous pouvez même créer votre propre modèle personnalisé. Il s'agira d'un point de départ défini et personnalisable pour vos utilisateurs.

Une fois que vous êtes satisfait des personnalisations de votre environnement, vous pouvez faciliter l'importation de votre projet dans IDX en ajoutant un bouton "Ouvrir dans IDX" à votre documentation, tel que le fichier README.md de votre projet.

Points d'entrée courants "Ouvrir dans IDX"

Plusieurs formats d'URL sont disponibles pour un bouton "Ouvrir dans IDX" :

  • Pour créer un lien vers le flux d'importation d'un dépôt Git prérempli avec l'URL de votre dépôt Git, utilisez le format d'URL suivant:

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

    À l'heure actuelle, seuls les dépôts GitHub sont compatibles (privés et publics).

  • Pour créer un lien vers un modèle d'espace de travail prédéfini, recherchez le modèle que vous recherchez sur la page Modèles dans IDX et copiez son URL, qui doit respecter le format d'URL suivant:

    https://idx.google.com/new/gemini
    
  • Pour créer un lien vers un modèle personnalisé prérempli avec l'URL GitHub de votre modèle, utilisez le format d'URL suivant:

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

Ajouter un bouton "Ouvrir dans IDX"

Utilisez cet outil pour générer le code HTML d'un bouton IDX: