Aggiungi o Aggiorna plugin

Questa guida spiega come aggiungere nuovi plugin Capacitor al sito Capgo o aggiornare la documentazione esistente di un plugin. Ciò è utile per i contributori, i mantenitori e gli agenti AI che aiutano a mantenere la documentazione.

Panoramica

Quando si aggiunge un nuovo plugin all'ecosistema Capgo, è necessario aggiornare diversi file e posizioni sul sito web per assicurarsi che il plugin apparisca correttamente in tutti i luoghi pertinenti:

1. Configurazione della Lista dei Plugin - Aggiungi metadati del plugin alla lista principale
2. Pagina Indice dei Plugin - Aggiungi plugin alla pagina di elenco dei plugin categorizzati
3. Navigazione del Lato - Aggiungi plugin alla navigazione del lato
4. Documentazione dei Plugin - Crea pagine di panoramica e avvio
5. Tutorial dei Plugin - Crea un tutorial completo

Posizioni dei file

File chiave da aggiornare

File	Scopo
/src/config/plugins.ts	Elenco plugin principale con metadati
/src/content/docs/docs/plugins/index.mdx	Pagina di indice dei plugin con categorie
/astro.config.mjs	Configurazione della navigazione laterale
/src/content/docs/docs/plugins/[plugin-name]/	Directory dei documenti del plugin
/src/content/plugins-tutorials/en/	File tutorial in inglese

Guida Passo-dopo-Passo

1. Aggiungi Plugin alla Lista Principale

   Apri /src/config/plugins.ts e aggiungi il tuo plugin all' actions array:

   // 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,
   }

   Icone Disponibili: Controlla /node_modules/astro-heroicons/mini/ per le icone disponibili.

2. Aggiungi Plugin alla Pagina di Indice

   Apri /src/content/docs/docs/plugins/index.mdx e aggiungi il tuo plugin nella categoria appropriata:

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

   Categorie:

   • ⭐ Plugin principali
   • 📱 Plugin dispositivi e sistema
   • 🎥 Plugin media e camera
   • 🛠️ Plugin utilità
   • 🤖 AI e media avanzati
   • 📍 Plugin posizione e servizi di background
   • 📞 Comunicazione e analisi
   • 🔐 Sicurezza e sistema
   • 📊 Caratteristiche Specifiche per Android
   • 📥 Scarica & Naviga

3. Aggiungi alla Navigazione del Lato

   Apre /astro.config.mjs e aggiungi il tuo plugin alla configurazione della navigazione del lato (circa linea 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,
   }

   I plugin sono elencati in ordine alfabetico nella navigazione del lato.

4. Crea Directory Documentazione Plugin

   Crea una nuova directory per la documentazione del tuo plugin:

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

5. Crea pagina di panoramica del plugin

   Crea /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. Crea guida introduttiva

   Crea /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. Crea file del tutorial

   Crea /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]

Struttura della documentazione del plugin

File richiesti

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 facoltativi

Per i plugin complessi, potresti aggiungere pagine di documentazione aggiuntive:

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

Linee guida per il contenuto

Scrivere Descrizioni dei Plugin

• Sii Conciso: Mantieni le descrizioni sotto i 100 caratteri
• Sii Preciso: Spiega cosa fa il plugin, non cosa è
• Usa Verbi d'Azione: Inizia con verbi come “Controllo”, “Integra”, “Abilita”

Esempi Buoni:

• “Controlla il flash del dispositivo e la torcia con un semplice interruttore on/off”
• “Integra il servizio di chat live Crisp e il supporto al cliente nel tuo app”
• “Abilita l'autenticazione sicura utilizzando Face ID e Touch ID”

Esempi Cattivi:

• “Un plugin per flash”
• “Questo è un plugin Crisp”
• Plugin di rilevamento biometrico

Scrivere la Documentazione

1. Inizia con l'Installazione: Inizia sempre con passaggi di installazione chiari
2. Fornisci Configurazione: Includi requisiti di configurazione specifici per piattaforma
3. Mostra Esempi di Utilizzo: Fornisci esempi di lavoro code
4. Includi API Reference: Documenta tutti i metodi e i parametri
5. Aggiungi Esempi Completi: Mostra modelli di utilizzo realistici
6. Elenco le Migliori Pratiche: Condividi consigli per un utilizzo ottimale
7. Documenta le Differenze di Piattaforma: Spiega il comportamento iOS vs Android
8. Aggiungi la Risoluzione dei Problemi: Affronta le questioni comuni

Code Esempi

• Usa TypeScript per tutti gli code esempi
• Includi le importazioni in alto
• Aggiungi commenti che spiegano i passaggi chiave
• Mostra il gestione degli errori
• Dimostra sia l'uso base che avanzato

Checklist

Usa questa checklist quando si aggiunge un nuovo plugin:

• Aggiunto plugin a /src/config/plugins.ts
• Selezionato icona appropriata da Heroicons
• Aggiunto plugin a /src/content/docs/docs/plugins/index.mdx Sotto la categoria corretta
• Aggiunto voce di navigazione laterale in /astro.config.mjs
• Creato directory documentazione plugin
• Creato index.mdx pagina di panoramica
• Creato getting-started.mdx guida
• Creato tutorial in /src/content/plugins-tutorials/en/
• Incluso istruzioni di installazione
• Documentato configurazione iOS
• Documentato configurazione Android
• Fornito esempi di utilizzo
• Aggiunto riferimento a API
• Esempio di lavoro completo incluso
• Elencate le migliori pratiche
• Aggiunte note specifiche per piattaforma
• Verificato che tutti i collegamenti funzionino correttamente

Riferimento alle icone

Icone comuni utilizzate per i plugin (da astro-heroicons/mini/):

Icona	Utilizzo
BoltIcon	Flash, potenza, energia
CameraIcon	Camera, foto, video
ChatBubbleLeftIcon	Chat, messaggistica, comunicazione
FingerPrintIcon	Biometria, sicurezza, autenticazione
MapPinIcon	Posizione, geolocalizzazione, mappe
SpeakerWaveIcon	Audio, suono, musica
VideoCameraIcon	Video, registrazione, streaming
CreditCardIcon	Pagamenti, acquisti
PlayCircleIcon	Reproducenti multimediali, riproduttori video
SignalIcon	Connettività, rete, beacon
RadioIcon	Beacon, trasmissione, wireless
ChatBubbleOvalLeftIcon	Social media, WeChat

Aggiornamento dei Plugin Esistenti

Quando si aggiorna un plugin esistente:

1. Aggiorna i numeri di versione nelle documentazioni
2. Aggiungi guide di migrazione se esistono cambiamenti di versione
3. Aggiorna la API reference con nuove metodi
4. Aggiungi nuovi esempi per nuove funzionalità
5. Aggiorna le richieste del sistema operativo se sono state apportate modifiche
6. Rivedi le migliori pratiche basate su nuove funzionalità
7. Mantieni aggiornato il tutorial con le ultime API

Percorsi di lingua

Scrivi e revisiona le documentazioni dei plugin in inglese. I percorsi localizzati sono generati dai metadati del sito e tradotti all'edge dal Worker di traduzione.

Testa le tue modifiche

Dopo aver aggiunto o aggiornato la documentazione dei plugin:

1. Costruisci il sito localmente:

   bun run build

2. Verifica gli errori:

   • Verifica che tutti i link funzionino
   • Assicurati che le immagini si caricano correttamente
   • Conferma che gli esempi di code sono validi
   • Testa la navigazione

3. Anteprima il sito:

   bun run dev

4. Verifica che il tuo plugin appare:

   • Controlla la pagina di elenco dei plugin
   • Verifica la navigazione del lato
   • Testa tutte le pagine di documentazione
   • Conferma che la pagina del tutorial funziona

Pitfall comuni

Attenzione

Evita questi errori comuni:

1. Dimenticare di sincronizzare: Esegui sempre bunx cap sync in esempi
2. Nomi inconsistenti: Utilizza lo stesso nome del plugin in ogni luogo
3. Configurazione della piattaforma mancante: Documenta sia la configurazione iOS che Android
4. Collegamenti rotti: Utilizza collegamenti relativi e verifica che funzionino
5. Nessuna gestione degli errori: Mostra sempre il try-catch negli esempi
6. Importazioni mancanti: Includi tutte le importazioni necessarie negli esempi
7. Descrizioni poco chiare: Sii specifico su cosa fa il plugin

Aiuto

Se hai bisogno di aiuto per aggiungere o aggiornare la documentazione del plugin:

• Discord: Unisciti alla nostra Comunità Discord
• GitHub: Apri un issue sul repository del sito web
• Email: Contattaci al supporto@capgo.app

Esempi

Per riferimento, controlla questi plugin ben documentati:

• Aggiornatore: /src/content/docs/docs/plugins/updater/ Plugin complesso con più pagine
• Flash: /src/content/docs/docs/plugins/flash/ Plugin semplice, buon esempio di partenza
• Accesso con account sociale: /src/content/docs/docs/plugins/social-login/ Riepilogo

Sezione intitolata “Riepilogo”

Adding a plugin to the Capgo documentation involves:

1. Aggiungere il plugin alla pagina di indice categorizzata
2. Configurare la navigazione laterale
3. Creare pagine di documentazione esaustive
4. Aggiungere il plugin alla pagina di indice categorizzata
5. Scrivere una guida dettagliata
6. Testare tutte le modifiche localmente

Seguendo questa guida, si assicura che i plugin siano documentati e facilmente scopribili dagli utenti.

Continua da Aggiungere o Aggiornare Plugin

Se stai utilizzando Aggiungere o Aggiornare Plugin per pianificare il lavoro di plugin nativo, connettilo con Capgo Directory dei Plugin per il flusso di lavoro del prodotto in Capgo Directory dei Plugin, Capacitor Plugin di Capgo per i dettagli di implementazione in Capacitor Plugin di Capgo Alternativi per Plugin di Enterprise di Ionic per il flusso di lavoro del prodotto in Alternativi per Plugin di Enterprise di Ionic, Capgo Costruzioni Native per il flusso di lavoro del prodotto in Capgo Costruzioni Native, e Capacitor Plugin: Cosa Devi Sapere per il contesto pratico in Capacitor Plugin: Cosa Devi Sapere.