Ajouter un bouton "Ouvrir dans IDX"

Avec Project IDX, vous pouvez simplifier la configuration de l'environnement de développement et la mise en route d'un nouvel utilisateur de votre codebase.

Par exemple,

  • Si vous travaillez en équipe avec d'autres contributeurs, vous pouvez personnaliser votre environnement précisément pour votre projet, puis valider votre fichier .idx/dev.nix dans le dépôt Git de votre projet. Ainsi, lorsqu'un collaborateur 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 d'IDE, scripts de démarrage, etc.

  • Si vous créez un framework ou une bibliothèque à l'usage d'autres utilisateurs, 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é comme point de départ personnalisable et orienté 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, comme le fichier README.md de votre projet.

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

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

  • Pour créer un lien vers le flux Importer un dépôt Git, prérempli avec l'URL de votre dépôt Git, utilisez ce modèle d'URL:

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

    Pour le moment, seuls les dépôts GitHub (privés et publics) sont compatibles.

  • Pour créer un lien vers un modèle d'espace de travail prédéfini, recherchez le modèle qui vous intéresse sur la page Modèles dans IDX, puis copiez son URL, qui doit suivre ce format:

    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 ce modèle d'URL:

    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: