Tambahkan tombol "Buka di IDX"

Dengan Project IDX, Anda dapat menyederhanakan langkah-langkah bagi seseorang yang baru mengenal codebase untuk menyiapkan lingkungan pengembangan mereka dan menjadi produktif.

Misalnya,

  • Jika mengerjakan tim dengan kontributor lain, Anda dapat menyesuaikan lingkungan secara tepat untuk project Anda, lalu meng-commit file .idx/dev.nix ke repositori Git project. Dengan demikian, saat rekan satu tim mengimpor repositori Git Anda di IDX, ruang kerja baru mereka akan memiliki konfigurasi yang sama persis dengan milik Anda, lengkap dengan paket sistem, ekstensi IDE, skrip awal, dan banyak lagi yang sama.

  • Jika Anda mem-build framework atau library untuk digunakan orang lain, Anda dapat menyertakan file .idx/dev.nix dalam repositori kode contoh, sehingga saat pengguna mengimpor contoh Anda ke IDX, mereka dapat melewati penyiapan lingkungan dan langsung mencoba framework Anda. Anda bahkan dapat membuat template kustom sendiri sebagai titik awal yang tidak dapat berubah dan dapat disesuaikan untuk pengguna.

Setelah puas dengan penyesuaian lingkungan, Anda dapat mempermudah orang lain mengimpor project ke IDX dengan menambahkan tombol "Open in IDX" ke dokumentasi, seperti file README.md project.

Titik masuk "Buka di IDX" yang umum

Ada beberapa pola URL yang tersedia untuk tombol "Buka di IDX":

  • Untuk menautkan ke alur impor repositori Git, yang telah diisi dengan URL repositori Git Anda, gunakan pola URL ini:

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

    Saat ini, hanya repositori GitHub yang didukung (baik pribadi maupun publik).

  • Untuk menautkan ke template ruang kerja standar, temukan template yang Anda cari di halaman Template di IDX, lalu salin URL-nya, yang harus mengikuti pola URL ini:

    https://idx.google.com/new/gemini
    
  • Untuk menautkan ke template kustom yang telah diisi sebelumnya dengan URL GitHub template Anda, gunakan pola URL ini:

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

Menambahkan tombol "Open in IDX"

Gunakan alat ini untuk membuat HTML untuk tombol IDX: