Menambahkan atau Mengupdate Plugin

Panduan ini menjelaskan cara menambahkan plugin baru Capacitor ke situs web Capgo atau memperbarui dokumentasi plugin yang sudah ada. Ini berguna bagi kontributor, pemelihara, dan agen AI yang membantu menjaga dokumentasi.

Ringkasan

Saat menambahkan plugin baru ke ekosistem Capgo, Anda perlu memperbarui beberapa file dan lokasi di situs web untuk memastikan plugin muncul dengan benar di semua tempat yang relevan:

1. Konfigurasi Daftar Plugin - Tambahkan metadata plugin ke daftar utama
2. Halaman Daftar Plugin - Tambahkan plugin ke halaman daftar plugin yang dikategorikan
3. Navigasi Samping - Tambahkan plugin ke sidebar dokumentasi
4. Dokumentasi Plugin - Buat halaman pengenalan dan getting-started
5. Tutorial Plugin - Buat tutorial yang komprehensif

Lokasi File

File Utama untuk Diperbarui

File	Tujuan
/src/config/plugins.ts	Daftar Plugin Utama dengan Metadata
/src/content/docs/docs/plugins/index.mdx	Halaman indeks plugin dengan kategori
/astro.config.mjs	Konfigurasi navigasi sampingan
/src/content/docs/docs/plugins/[plugin-name]/	Direktori dokumentasi plugin
/src/content/plugins-tutorials/en/	File tutorial bahasa Inggris

Petunjuk Langkah demi Langkah

1. Tambahkan Plugin ke Daftar Utama

   Buka /src/config/plugins.ts dan tambahkan plugin Anda ke actions __CAPGO_KEEP_0__

   // First, import an appropriate Heroicon
   import YourIconName from 'astro-heroicons/mini/IconName.astro'
   
   // Then add to the actions array
   {
     name: '@capgo/your-plugin-name',
     author: 'github.com/Cap-go',
     description: 'Brief description of what the plugin does',
     href: 'https://github.com/Cap-go/your-plugin-name/',
     title: 'Display Name',
     icon: YourIconName,
   }

   Ikon-Ikon yang TersediaCek /node_modules/astro-heroicons/mini/ untuk melihat ikon-ikon yang tersedia.

2. Tambahkan Plugin ke Halaman Index

   Buka /src/content/docs/docs/plugins/index.mdx dan tambahkan plugin Anda di kategori yang sesuai:

   <LinkCard
     title="Your Plugin Name"
     description="Brief description of what the plugin does"
     href="/docs/plugins/your-plugin-name/"
   />

   Kategori:

   • ⭐ Plugin-Plugin Terpopuler
   • 📱 Plugin-Plugin Perangkat & Sistem
   • 🎥 Plugin-Plugin Media & Kamera
   • 🛠️ Plugin-Utilitas
   • 🤖 AI & Media Maju
   • 📍 Lokasi & Layanan Latar
   • 📞 Komunikasi & Analitik
   • 🔐 Keamanan & Sistem
   • 📊 Fitur Android-Spesifik
   • 📥 Unduh & Navigasi

3. Tambahkan ke Navigasi Samping

   Buka /astro.config.mjs dan tambahkan plugin Anda ke konfigurasi samping (sekitar baris 540):

   {
     label: 'Your Plugin Name',
     items: [
       { label: 'Overview', link: '/docs/plugins/your-plugin-name/' },
       { label: 'Getting started', link: '/docs/plugins/your-plugin-name/getting-started' },
     ],
     collapsed: true,
   }

   Plugins ditampilkan secara alfabetis di sidebar.

4. Buat Direktori Dokumentasi Plugin

   Buat direktori baru untuk dokumentasi plugin Anda:

   mkdir -p /src/content/docs/docs/plugins/your-plugin-name/

5. Buat Halaman Ringkasan Plugin

   Buat /src/content/docs/docs/plugins/your-plugin-name/index.mdx:

   ---
   title: "@capgo/your-plugin-name"
   description: Brief description of the plugin's purpose
   tableOfContents: false
   next: false
   prev: false
   sidebar:
     order: 1
     label: "Introduction"
   hero:
     tagline: Detailed tagline explaining what the plugin does
     image:
       file: ~public/your-plugin-icon.svg
     actions:
       - text: Get started
         link: /docs/plugins/your-plugin-name/getting-started/
         icon: right-arrow
         variant: primary
       - text: Github
         link: https://github.com/Cap-go/your-plugin-name/
         icon: external
         variant: minimal
   ---
   
   import { Card, CardGrid } from '@astrojs/starlight/components';
   
   <CardGrid stagger>
     <Card title="Feature 1" icon="puzzle">
       Description of first key feature
     </Card>
     <Card title="Feature 2" icon="rocket">
       Description of second key feature
     </Card>
     <Card title="Cross-platform" icon="puzzle">
       Works on both iOS and Android 📱
     </Card>
     <Card title="Comprehensive Documentation" icon="open-book">
       Check the [Documentation](/docs/plugins/your-plugin-name/getting-started/) to master the plugin.
     </Card>
   </CardGrid>

6. Buat Panduan Mulai

   Buat /src/content/docs/docs/plugins/your-plugin-name/getting-started.mdx:

   ---
   title: Getting Started
   description: Learn how to install and use the plugin in your Capacitor app.
   sidebar:
     order: 2
   ---
   
   import { Steps } from '@astrojs/starlight/components';
   import { PackageManagers } from 'starlight-package-managers'
   
   <Steps>
   1. **Install the package**
      <PackageManagers pkg="@capgo/your-plugin-name" pkgManagers={['npm', 'pnpm', 'yarn', 'bun']} />
   
   2. **Sync with native projects**
      <PackageManagers type="exec" pkg="cap" args="sync" pkgManagers={['npm', 'pnpm', 'yarn', 'bun']} />
   </Steps>
   
   ## Configuration
   
   ### iOS Configuration
   [iOS-specific setup instructions]
   
   ### Android Configuration
   [Android-specific setup instructions]
   
   ## Usage
   
   [Basic usage examples]
   
   ## API Reference
   
   [Detailed API documentation]
   
   ## Complete Example
   
   [Full working example]
   
   ## Best Practices
   
   [Recommended practices and tips]
   
   ## Platform Notes
   
   [Platform-specific notes and limitations]

7. Buat File Tutorial

   Buat /src/content/plugins-tutorials/en/your-plugin-name.md:

   ---
   locale: en
   ---
   # Using @capgo/your-plugin-name Package
   
   The `@capgo/your-plugin-name` package [brief description]. In this tutorial, we will guide you through the installation, configuration, and usage of this package in your Ionic Capacitor app.
   
   ## Installation
   
   [Installation steps]
   
   ## Configuration
   
   [Configuration steps for iOS and Android]
   
   ## API Usage
   
   [Detailed API usage examples]
   
   ## Complete Example
   
   [Full working example]
   
   ## Best Practices
   
   [Tips and best practices]
   
   ## Troubleshooting
   
   [Common issues and solutions]
   
   ## Conclusion
   
   [Summary and links to additional resources]

Struktur Dokumentasi Plugin

File yang Diperlukan

src/content/docs/docs/plugins/your-plugin-name/
├── index.mdx           # Overview page with hero and feature cards
└── getting-started.mdx # Installation and usage guide

src/content/plugins-tutorials/en/
└── your-plugin-name.md # Comprehensive tutorial

File Opsional

Untuk plugin yang kompleks, Anda mungkin menambahkan halaman dokumentasi tambahan:

src/content/docs/docs/plugins/your-plugin-name/
├── index.mdx
├── getting-started.mdx
├── api-reference.mdx   # Detailed API documentation
├── examples.mdx        # Additional examples
├── troubleshooting.mdx # Troubleshooting guide
└── migrations.mdx      # Migration guides

Pedoman Konten

Membuat Deskripsi Plugin

• Jadilah Singkat: Jangan melebihi 100 karakter
• Jadilah Spesifik: Jelaskan apa yang plugin lakukan, bukan apa itu
• __CAPGO_KEEP_0__Mulai dengan kata kerja seperti “Kontrol”, “Integrasikan”, “Aktifkan”

Contoh yang Baik:

• “Kontrol lampu flash dan senter dengan toggle on/off sederhana”
• “Integrasikan obrolan live Crisp dan dukungan pelanggan ke aplikasi Anda”
• “Aktifkan autentikasi yang aman menggunakan Face ID dan Touch ID”

Contoh yang Buruk:

• “Plugin untuk flash”
• “Ini adalah plugin Crisp”
• “Plugin biometrik”

Membuat Dokumentasi

1. Mulai dengan InstalasiSelalu mulai dengan langkah instalasi yang jelas
2. Berikan KonfigurasiTermasuk persyaratan pengaturan spesifik platform
3. Tunjukkan Contoh PenggunaanBerikan contoh code yang berfungsi
4. Termasuk Referensi APIDokumentasikan semua metode dan parameter
5. Tambahkan Contoh yang LengkapTunjukkan pola penggunaan nyata
6. Daftar Praktik TerbaikBagikan tips untuk penggunaan optimal
7. Dokumentasikan Perbedaan PlatformMengklarifikasi perilaku iOS vs Android
8. Tambahkan Troubleshooting: Alamat masalah umum

Contoh Code

• Gunakan TypeScript untuk semua contoh code
• Masukkan import di bagian atas
• Tambahkan komentar menjelaskan langkah kunci
• Tampilkan penanganan kesalahan
• Menggambarkan penggunaan dasar dan canggih

Daftar Periksa

Gunakan daftar periksa ini ketika menambahkan plugin baru:

• Menambahkan plugin ke /src/config/plugins.ts
• Memilih ikon yang tepat dari Heroicons
• Menambahkan plugin ke /src/content/docs/docs/plugins/index.mdx kategori yang benar
• Menambahkan entri sampingan di /astro.config.mjs
• Membuat direktori dokumentasi plugin
• Membuat index.mdx halaman ringkasan
• Membuat getting-started.mdx panduan
• Membuat tutorial di /src/content/plugins-tutorials/en/
• Termasuk instruksi instalasi
• Dokumentasi konfigurasi iOS
• Dokumentasi konfigurasi Android
• Diberikan contoh penggunaan
• Menambahkan referensi API
• Termasuk contoh kerja yang lengkap
• Daftar praktik terbaik
• Menambahkan catatan spesifik platform
• Ditesting semua tautan bekerja dengan benar

Referensi Icon

Ikon umum digunakan untuk plugin (dari astro-heroicons/mini/):

Ikon	Penggunaan Kasus
BoltIcon	Panas, daya, energi
CameraIcon	Kamera, foto, video
ChatBubbleLeftIcon	Chat, pesan, komunikasi
FingerPrintIcon	Biometrik, keamanan, autentikasi
MapPinIcon	Lokasi, geolokasi, peta
SpeakerWaveIcon	Audio, suara, musik
VideoCameraIcon	Video, rekaman, streaming
CreditCardIcon	Pembayaran, pembelian
PlayCircleIcon	Pemain media, pemutar video
SignalIcon	Koneksi, jaringan, beacon
RadioIcon	Beacon, siaran, nirkabel
ChatBubbleOvalLeftIcon	Sosial media, WeChat

Mengupdate Plugin yang Ada

Ketika mengupdate plugin yang ada:

1. Perbarui nomor versi dalam dokumentasi
2. Tambahkan panduan migrasi jika perubahan yang mengganggu ada
3. Perbarui API referensi dengan metode baru
4. Tambahkan contoh baru untuk fitur baru
5. Perbarui persyaratan platform jika berubah
6. Revisi praktik terbaik berdasarkan fitur baru
7. Tetapkan tutorial saat ini dengan API terbaru

Jalur Bahasa

Tulis dan tinjau dokumen plugin dalam bahasa Inggris. Jalur lokal diperbarui oleh metadata situs dan diterjemahkan di tepi oleh pekerjaan penerjemahan.

Menguji Perubahan Anda

Setelah menambahkan atau memperbarui dokumentasi plugin:

1. Bangun situs secara lokal:

   bun run build

2. Periksa kesalahan:

   • Pastikan semua tautan berfungsi
   • Pastikan gambar muat dengan benar
   • Konfirmasi contoh code yang valid
   • Uji navigasi bekerja

3. Tinjau situs:

   bun run dev

4. Pastikan plugin Anda muncul:

   • Periksa halaman daftar plugin
   • Pastikan navigasi sampingan
   • Uji semua halaman dokumentasi
   • Konfirmasi halaman tutorial berfungsi

Kesalahan Umum

Peringatan

Hindari kesalahan umum ini:

1. Lupa menyinkronkan: Selalu jalankan bunx cap sync Dalam contoh-contoh
2. Penamaan tidak konsisten: Gunakan nama plugin yang sama di mana-mana
3. Konfigurasi platform hilang: Dokumentasikan setup iOS dan Android
4. Tautan rusak: Gunakan tautan relatif dan pastikan mereka berfungsi
5. Tidak ada penanganan kesalahan: Selalu tunjukkan try-catch di contoh-contoh
6. Impor hilang: Termasuk semua impor yang diperlukan di contoh-contoh
7. Pengertian tidak jelasJelaskan secara spesifik apa yang dilakukan plugin ini

Bantuan

Jika Anda membutuhkan bantuan untuk menambahkan atau memperbarui dokumentasi plugin:

• DiscordGabunglah dengan Komunitas Discord
• GitHubBuka isu pada repositori Situs web
• EmailHubungi tim di Dukungan@capgo.app

Contoh

Untuk referensi, periksa plugin yang terdokumentasi dengan baik ini:

• Pengatur: /src/content/docs/docs/plugins/updater/ (plugin kompleks dengan beberapa halaman)
• Flash: /src/content/docs/docs/plugins/flash/ (plugin sederhana, contoh awal yang baik)
• Login Sosial: /src/content/docs/docs/plugins/social-login/ (plugin dengan sub-halaman)

Ringkasan

Mengambahkan plugin ke Capgo dokumentasi melibatkan:

1. Mengambahkan metadata ke konfigurasi utama
2. Mengambahkan plugin ke halaman indeks kategori
3. Mengatur navigasi sampingan
4. Membuat halaman dokumentasi yang komprehensif
5. Mengarang tutorial yang rinci
6. Menguji semua perubahan secara lokal

Dengan mengikuti panduan ini, Anda memastikan bahwa plugin terdokumentasi secara konsisten dan mudah ditemukan oleh pengguna.

Teruskan dari Mengambahkan atau Mengupdate Plugin

Jika Anda menggunakan Mengambahkan atau Mengupdate Plugin untuk merencanakan pekerjaan plugin native, hubungkannya dengan Capgo Direktori Plugin untuk alur kerja produk di Capgo Direktori Plugin, Capacitor Plugin oleh Capgo untuk detail implementasi di Capacitor Plugin oleh Capgo, Alternatif Plugin Enterprise Ionic untuk alur kerja produk di Alternatif Plugin Enterprise Ionic, Capgo Pembangunan Native untuk alur kerja produk di Capgo Pembangunan Native, dan Capacitor Plugin: Apa yang Anda Perlu Ketahui untuk konteks praktis di Capacitor Plugin: Apa yang Anda Perlu Ketahui.