Ajouter un bouton "Ouvrir dans IDX"

Project IDX vous permet de simplifier la procédure pour les nouveaux utilisateurs de votre codebase. pour configurer leur environnement de développement et être productifs.

Par exemple,

  • Si vous travaillez en équipe avec d'autres contributeurs, vous pouvez personnaliser votre environnement précisément pour votre projet puis validez votre fichier .idx/dev.nix dans le dépôt Git de votre projet. Ainsi, lorsqu'un collègue importe votre dépôt Git dans IDX, son le nouvel espace de travail aura exactement la même configuration que la vôtre, 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, de sorte que, lorsque Lorsqu'un utilisateur importe vos échantillons dans IDX, il peut ignorer l'environnement et passer directement à l'essai de votre framework. Vous pouvez même créer votre propre modèle personnalisé, et personnalisable pour vos utilisateurs.

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

"Ouvrir en IDX" les plus courants points d'entrée

Plusieurs formats d'URL sont disponibles pour une requête "Ouvrir dans IDX" bouton disponibles:

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

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

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

  • Pour créer un lien vers un modèle d'espace de travail prédéfini, recherchez le modèle en question que vous recherchez sur la page Modèles IDX, puis copiez son URL, qui doit respecter le format 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, procédez comme suit : utilisez ce format d'URL:

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

Ajouter une clé "Ouvrir dans IDX" bouton

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