Ajouter ou mettre à jour des plugins

Ce guide explique comment ajouter de nouveaux Capacitor plugins au site Capgo ou mettre à jour la documentation d'un plugin existant. Cela est utile pour les contributeurs, les gestionnaires et les agents IA aidant à maintenir la documentation.

Vue d'ensemble

Lors de l'ajout d'un nouveau plugin à l'écosystème Capgo, vous devez mettre à jour plusieurs fichiers et emplacements sur le site pour s'assurer que le plugin apparaisse correctement dans tous les endroits pertinents :

1. Configuration de la liste des plugins - Ajouter les métadonnées du plugin à la liste principale
2. Page d'index des plugins - Ajouter le plugin à la page de liste des plugins catégorisés
3. Navigation latérale - Ajoutez le plugin au menu de documentation
4. Documentation du Plugin - Créez des pages d'aperçu et de démarrage
5. Tutoriel du Plugin - Créez un tutoriel complet

Emplacements des fichiers

Fichiers clés à mettre à jour

Fichier	Objectif
/src/config/plugins.ts	Liste des plugins maîtres avec métadonnées
/src/content/docs/docs/plugins/index.mdx	Page d'index des plugins avec catégories
/astro.config.mjs	Configuration de navigation du côté gauche
/src/content/docs/docs/plugins/[plugin-name]/	Dossier de documentation du plugin
/src/content/plugins-tutorials/en/	Fichiers de tutoriel en anglais

Guide étape par étape

1. Ajouter le plugin à la liste principale

   Ouvrir /src/config/plugins.ts et ajoutez votre plugin à l' 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,
   }

   Icônes disponibles : Vérifier /node_modules/astro-heroicons/mini/ les icônes disponibles.

2. Ajouter un plugin à la page d'accueil

   Ouvrir /src/content/docs/docs/plugins/index.mdx et ajoutez votre plugin sous la catégorie appropriée :

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

   Catégories:

   • ⭐ Plugins en vedette
   • 📱 Plugins de dispositif et de système
   • 🎥 Plugins multimédia et de caméra
   • 🛠️ Plugins d'utilité
   • 🤖 Intelligence artificielle & médias avancés
   • 📍 Localisation & services de fond
   • 📞 Communication & analyse
   • 🔐 Sécurité & système
   • 📊 Fonctionnalités spécifiques à Android
   • 📥 Téléchargement & navigation

3. Ajouter à la navigation de côté

   Ouvrir /astro.config.mjs et ajoutez votre plugin à la configuration de la navigation de côté (environ ligne 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,
   }

   Les plugins sont listés alphabétiquement dans la barre latérale.

4. Créer le répertoire de documentation du plugin

   Créez un nouveau répertoire pour la documentation de votre plugin :

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

5. Créer la page d'accueil du plugin

   Créer /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. Créer le guide de démarrage

   Créer /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. Créer le fichier de tutoriel

   Créer /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]

Structure de la documentation du plugin

Fichiers requis

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

Fichiers optionnels

Pour les plugins complexes, vous pouvez ajouter des pages de documentation supplémentaires :

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

Lignes directrices du contenu

Écrire les descriptions de plugins

• Soyez concis: Gardez les descriptions sous 100 caractères
• Soyez spécifique: Expliquez ce que fait le plugin, et non ce qu'il est
• Utilisez des verbes d'actionCommencez par des verbes comme « Contrôler », « Intégrer », « Activer »

Exemples de qualité:

• « Contrôler la lumière de l'appareil photo et de la torche avec un simple bouton d'allumage »
• « Intégrer le chat en direct Crisp et le support client à votre application »
• « Activer une authentification sécurisée en utilisant Face ID et Touch ID »

Exemples de mauvaise qualité:

• « Un plugin pour la lumière flash »
• « C'est un plugin Crisp »
• « Plugin biométrique »

Écrire la documentation

1. Commencez par l'Installation: Toujours commencer par des étapes d'installation claires
2. Fourir de la Configuration: Inclure les exigences de configuration spécifiques au système
3. Montrer des Exemples d'Utilisation: Fournir des exemples code fonctionnels
4. Inclure la API Référence: Documenter tous les méthodes et paramètres
5. Ajouter des Exemples Complets: Montrer des modèles d'utilisation du monde réel
6. Lister les Meilleures Pratiques: Partager des conseils pour un usage optimal
7. Documenter les Différences de Plateforme: Comprendre le comportement iOS vs Android
8. Ajouter des étapes de dépannage: Résoudre les problèmes courants

Code Exemples

• Utiliser TypeScript pour tous les code exemples
• Inclure les imports en haut
• Ajouter des commentaires expliquant les étapes clés
• Afficher la gestion des erreurs
• Démontrer à la fois l'utilisation de base et avancée

Liste de vérification

Utilisez ce tableau de contrôle lors de l'ajout d'un nouveau plugin :

• Ajouté le plugin à /src/config/plugins.ts
• Sélectionné l'icône appropriée de Heroicons
• Ajouté le plugin à /src/content/docs/docs/plugins/index.mdx sous la catégorie correcte
• Ajouté une entrée de sidebar dans /astro.config.mjs
• Créé le répertoire de documentation du plugin
• Créé index.mdx la page d'aperçu
• Créé getting-started.mdx la guide
• Créé un tutoriel dans /src/content/plugins-tutorials/en/
• Instructions d'installation incluses
• Configuration iOS documentée
• Configuration Android documentée
• Exemples d'utilisation fournis
• Ajout d'une référence à API
• Exemple de travail complet inclus
• Pratiques recommandées listées
• Notes spécifiques aux plateformes ajoutées
• Tous les liens ont été testés avec succès

Référence des icônes

Icônes courantes utilisées pour les plugins (de astro-heroicons/mini/):

Icône	Utilisation
BoltIcon	Éclairage, puissance, énergie
CameraIcon	Caméra, photo, vidéo
ChatBubbleLeftIcon	Chat, messagerie, communication
FingerPrintIcon	Biométrie, sécurité, authentification
MapPinIcon	Localisation, géolocalisation, cartes
SpeakerWaveIcon	Audio, son, musique
VideoCameraIcon	Vidéo, enregistrement, streaming
CreditCardIcon	Paiements, achats
PlayCircleIcon	Joueurs multimédia, lecteurs vidéo
SignalIcon	Connectivité, réseau, balise
RadioIcon	Beacon, diffusion, sans fil
ChatBubbleOvalLeftIcon	Réseaux sociaux, WeChat

Mise à jour des plugins existants

Lors de la mise à jour d'un plugin existant :

1. Mettre à jour les numéros de version dans la documentation
2. Ajouter des guides de migration si des changements de rupture existent
3. Mettre à jour la référence API avec de nouvelles méthodes
4. Ajouter de nouveaux exemples pour de nouvelles fonctionnalités
5. Mettre à jour les exigences de la plateforme si modifiées
6. Réviser les meilleures pratiques sur la base de nouvelles fonctionnalités
7. Tenir le tutoriel à jour avec les derniers API

Chemins de Langue

Écrire et passer en revue les documents de plugin en anglais. Les chemins localisés sont générés par les métadonnées du site et traduits en bordure par le Worker de traduction.

Tester vos modifications

Après avoir ajouté ou mis à jour la documentation du plugin :

1. Construire le site localement:

   bun run build

2. Vérifier les erreurs:

   • Vérifier que tous les liens fonctionnent
   • S'assurer que les images chargent correctement
   • Confirmer que les exemples code sont valides
   • Tester la navigation

3. Prévisualiser le site:

   bun run dev

4. Vérifiez que votre plugin est visible:

   • Vérifiez la page de liste des plugins
   • Vérifiez la navigation du côté gauche
   • Testez toutes les pages de documentation
   • Vérifiez que la page de tutoriel fonctionne

Pitfalls courants

Attention

Évitez ces erreurs courantes :

1. Oublier de synchroniser: Exécutez toujours bunx cap sync dans les exemples
2. Nommage incohérentUtilisez le même nom de plugin partout
3. Configuration de plateforme manquanteDocumentez les deux paramètres iOS et Android
4. Liens brisésUtilisez des liens relatifs et vérifiez qu'ils fonctionnent
5. Aucun traitement d'erreurAffichez toujours des try-catch dans les exemples
6. Importations manquantesIncluez toutes les importations nécessaires dans les exemples
7. Descriptions ambiguës: Soyez spécifique sur ce que fait le plugin

Aide

Si vous avez besoin d'aide pour ajouter ou mettre à jour la documentation du plugin :

• Discord: Rejoignez notre communauté Discord
• GitHub: Ouvrez une question sur le répertoire du site web
• Courriel: Contactez l'équipe à support@capgo.app

Exemples

Pour référence, consultez ces plugins bien documentés :

• Mise à jour: /src/content/docs/docs/plugins/updater/ (plugin complexe avec plusieurs pages)
• Flash: /src/content/docs/docs/plugins/flash/ (plugin simple, bon exemple de démarrage)
• Connexion sociale: /src/content/docs/docs/plugins/social-login/ (plugin avec sous-pages)

Résumé

La mise en place d'un plugin dans la Capgo documentation implique :

1. La mise à jour des métadonnées de la configuration principale
2. L'ajout du plugin à la page d'index de catégorisation
3. La configuration de la navigation de côté
4. La création de pages de documentation complètes
5. L'écriture d'un tutoriel détaillé
6. La mise en œuvre de tests locaux de toutes les modifications

En suivant ce guide, vous vous assurez que les plugins sont documentés de manière cohérente et facilement découvrables par les utilisateurs.

Continuez de la section Ajouter ou Mettre à jour les plugins

Si vous utilisez Ajouter ou Mettre à jour les plugins pour planifier le travail de plugin natif, connectez-le à Capgo Répertoire de plugin pour le flux de travail du produit dans Capgo Répertoire de plugin, Capacitor Plugins par Capgo pour les détails d'implémentation dans Capacitor Plugins par Capgo, Alternatives de plugin d'entreprise Ionic pour le flux de travail du produit dans Alternatives de plugin d'entreprise Ionic, Capgo Bâtiments natifs pour le flux de travail du produit dans Capgo Bâtiments natifs, et Capacitor Plugins : Ce que vous devez savoir pour le contexte pratique dans Capacitor Plugins : Ce que vous devez savoir.