Menambahkan atau Mengupdate Plugin
Salin prompt pengaturan dengan langkah instalasi dan panduan markdown lengkap untuk plugin ini.
Panduan ini menjelaskan cara menambahkan plugin baru Capacitor ke situs Capgo atau memperbarui dokumentasi plugin yang sudah ada. Ini berguna bagi kontributor, pengelola, dan agen AI yang membantu menjaga dokumentasi.
Ringkasan
Bab berjudul “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:
- Konfigurasi Daftar Plugin - Tambahkan metadata plugin ke daftar utama
- Halaman Daftar Plugin - Tambahkan plugin ke halaman daftar plugin yang dikategorikan
- Navigasi Samping - Tambahkan plugin ke sidebar dokumentasi
- Dokumentasi Plugin - Buat halaman pengenalan dan cara memulai
- Tutorial Plugin - Buat tutorial yang komprehensif
Lokasi File
Bagian berjudul “Lokasi File”File Utama untuk Diperbarui
Bagian berjudul “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
Judul bagian “Petunjuk Langkah demi Langkah”-
Tambahkan Plugin ke Daftar Utama
Judul bagian “Tambahkan Plugin ke Daftar Utama”Buka
/src/config/plugins.tsdan tambahkan plugin Anda keactionsarray:// First, import an appropriate Heroiconimport 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. -
Tambahkan Plugin ke Halaman Index
Judul bagian “Tambahkan Plugin ke Halaman Index”Buka
/src/content/docs/docs/plugins/index.mdxdan tambahkan plugin Anda di kategori yang sesuai:<LinkCardtitle="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
-
Tambahkan ke Navigasi Samping
Judul Bagian “Tambahkan ke Navigasi Samping”Buka
/astro.config.mjsdan tambahkan plugin Anda ke konfigurasi samping (sekitar garis 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,}Plugin-plugin tersebut terdaftar secara alfabetis di sidebar.
-
Buat Dokumen Plugin
Bab berjudul “Buat Dokumen Plugin”Buat direktori baru untuk dokumen plugin Anda:
Jendela terminal mkdir -p /src/content/docs/docs/plugins/your-plugin-name/ -
Buat Halaman Ringkasan Plugin
Bab berjudul “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 purposetableOfContents: falsenext: falseprev: falsesidebar:order: 1label: "Introduction"hero:tagline: Detailed tagline explaining what the plugin doesimage:file: ~public/your-plugin-icon.svgactions:- text: Get startedlink: /docs/plugins/your-plugin-name/getting-started/icon: right-arrowvariant: primary- text: Githublink: https://github.com/Cap-go/your-plugin-name/icon: externalvariant: 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> -
Buat Panduan Mulai
Bab berjudul “Buat Panduan Mulai”Buat
/src/content/docs/docs/plugins/your-plugin-name/getting-started.mdx:---title: Getting Starteddescription: 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] -
Buat File Tutorial
Judul Bagian “Buat File Tutorial”Buat
/src/content/plugins-tutorials/en/your-plugin-name.md:---locale: en---# Using @capgo/your-plugin-name PackageThe `@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
Judul Bagian “Struktur Dokumentasi Plugin”File yang Diperlukan
Judul Bagian “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 tutorialFile Opsional
Bagian berjudul “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 guidesPedoman Konten
Bagian berjudul “Pedoman Konten”Menulis Deskripsi Plugin
Bagian berjudul “Menulis Deskripsi Plugin”- Jadilah Singkat: Simpan deskripsi di bawah 100 karakter
- Jadilah Spesifik: Jelaskan apa yang plugin lakukan, bukan apa itu
- Gunakan Kata KerjaMulai dengan kata kerja seperti “Kontrol”, “Integrasikan”, “Aktifkan”
Contoh yang Baik:
- “Kontrol lampu flash dan senter dengan toggle on/off yang 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
Judul bagian “Membuat Dokumentasi”- Mulai dengan InstalasiSelalu mulai dengan langkah instalasi yang jelas
- Berikan KonfigurasiTermasuk persyaratan pengaturan spesifik platform
- Tunjukkan Contoh PenggunaanBerikan contoh code yang berfungsi
- Termasuk API ReferensiDokumentasikan semua metode dan parameter
- Tambahkan Contoh yang LengkapTunjukkan pola penggunaan nyata
- Daftar Praktik TerbaikBagikan tips untuk penggunaan optimal
- Dokumentasikan Perbedaan PlatformMengklarifikasi perilaku iOS vs Android
- Tambahkan Troubleshooting: Mengatasi masalah umum
Contoh Code
Bab berjudul “Code Contoh”- Gunakan TypeScript untuk semua code contoh
- Termasuk import di bagian atas
- Tambahkan komentar menjelaskan langkah kunci
- Tampilkan penanganan kesalahan
- Menggambarkan penggunaan dasar dan canggih
Daftar Periksa
Bab berjudul “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.mdxkategori yang benar - Menambahkan entri sisi di
/astro.config.mjs - Membuat direktori dokumentasi plugin
- Membuat
index.mdxhalaman ringkasan - Membuat
getting-started.mdxpanduan - Membuat tutorial di
/src/content/plugins-tutorials/en/ - Pasang instruksi instalasi
- Dokumentasi konfigurasi iOS
- Dokumentasi konfigurasi Android
- Contoh penggunaan yang disediakan
- Menambahkan referensi API
- Menghubungkan contoh kerja yang lengkap
- Daftar praktik terbaik
- Menambahkan catatan spesifik platform
- Menguji semua tautan yang berfungsi dengan benar
Referensi Icon
Bab berjudul “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, pemain video |
SignalIcon | Koneksi, jaringan, beacon |
RadioIcon | Sinyal, siaran, nirkabel |
ChatBubbleOvalLeftIcon | Media sosial, WeChat |
Mengupdate Plugin yang Ada
Judul bagian “Mengupdate Plugin yang Ada”Ketika mengupdate plugin yang ada:
- Perbarui nomor versi di dokumentasi
- Tambahkan panduan migrasi jika perubahan yang mengganggu ada
- Perbarui API referensi dengan metode baru
- Tambahkan contoh baru untuk fitur baru
- Perbarui persyaratan platform jika berubah
- Revisi praktik terbaik berdasarkan fitur baru
- Tetapkan tutorial saat ini dengan API terbaru
Jalur Bahasa
Judul Bagian “Jalur Bahasa”Tulis dan tinjau dokumen plugin dalam bahasa Inggris. Jalur lokal dihasilkan oleh metadata situs dan diterjemahkan di tepi oleh pekerja penerjemahan.
Menguji Perubahan Anda
Judul Bagian “Menguji Perubahan Anda”Setelah menambahkan atau memperbarui dokumentasi plugin:
-
Bangun situs secara lokal:
Jendela terminal bun run build -
Periksa kesalahan:
- Pastikan semua tautan berfungsi
- Pastikan gambar muat dengan benar
- Konfirmasi contoh code yang valid
- Uji navigasi bekerja
-
Tinjau situs:
Jendela terminal bun run dev -
Pastikan plugin Anda muncul:
- Periksa halaman daftar plugin
- Pastikan navigasi sampingan berfungsi
- Test semua halaman dokumentasi
- Pastikan halaman tutorial berfungsi
Kesalahan Umum
Judul bagian “Kesalahan Umum”Mendapatkan Bantuan
Judul bagian “Mendapatkan Bantuan”Jika Anda membutuhkan bantuan untuk menambahkan atau memperbarui dokumentasi plugin:
- DiscordGabung dengan komunitas Discord
- GitHubTerbuka isu di repositori Website
- EmailHubungi tim di support@capgo.app
Contoh-Contoh
Bagian berjudul “Contoh-Contoh”Untuk referensi, cek plugin-plugin ini yang terdokumentasi dengan baik:
- Pengupdate:
/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
Bagian berjudul “Ringkasan”Menambahkan plugin ke Capgo dokumentasi melibatkan:
- Menambahkan metadata ke konfigurasi utama
- Menambahkan plugin ke halaman indeks kategori
- Mengonfigurasi navigasi sampingan
- Membuat halaman dokumentasi yang komprehensif
- Membuat tutorial yang rinci
- Menguji semua perubahan secara lokal
Dengan mengikuti panduan ini, Anda memastikan bahwa plugin terdokumentasi secara konsisten dan mudah ditemukan oleh pengguna.
Teruskan dari Menambahkan atau Mengupdate Plugin
Bagian berjudul “Teruskan dari Menambahkan atau Mengupdate Plugin”Jika Anda menggunakan Menambahkan 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.