Ajout ou mise à jour de plugins

Cette guide explique comment ajouter de nouveaux plugins Capacitor au site Web 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 Web pour vous 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 - Ajouter le plugin à la barre de navigation latérale
4. Documentation du plugin - Créer des pages d'aperçu et de démarrage rapide
5. Tutoriel du plugin - Créer un tutoriel complet

Emplacements de fichiers

Fichiers clés à mettre à jour

Fichier	Objectif
/src/config/plugins.ts	Liste principale de plugins 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]/	Répertoire de documentation des plugins
/src/content/plugins-tutorials/en/	Fichiers de tutoriel en anglais

Guide étape par étape

1. Ajouter un plugin à la liste principale

   Ouvrir /src/config/plugins.ts et ajoutez votre plugin à l'array : actions Copier dans le presse-papiers

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

   Vérifiez :les icônes disponibles. /node_modules/astro-heroicons/mini/ Ajouter un plugin à la page d'accueil

2. Section intitulée « Ajouter un plugin à la page d'accueil »

   Ouvrir /src/content/docs/docs/plugins/index.mdx et ajoutez votre plugin dans 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 mis en avant ⭐
   • Plugins de périphérique et de système 📱
   • Plugins multimédia et de caméra 🎥
   • Plugins d'utilité 🛠️
   • Plugins AI et multimédia avancé 🤖
   • Plugins de localisation et de services de fond 📍
   • Plugins de communication et d'analytique 📞
   • Plugins de sécurité et de système 🔐
   • 📊 Fonctionnalités Spécifiques à Android
   • 📥 Téléchargement & Navigation

3. Ajouter à la Navigation de la Barre Latérale

   Ouvrir /astro.config.mjs et ajoutez votre plugin à la configuration de la barre latérale (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'aperçu 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 facultatifs

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

Ecrire les descriptions de plugins

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

Exemples de bonne pratique:

• “Contrôlez l’éclairage de la caméra et de la torche avec un simple bouton d’allumage et d’éteignage”
• “Intégrez le chat en direct Crisp et le support client à votre application”
• “Activez une authentification sécurisée en utilisant Face ID et Touch ID”

Exemples Mauvais:

• “Un plugin pour flash”
• “Ceci est un plugin Crisp”
• “Plugin biométrique”

Écrire la Documentation

1. Commencez par l'Installation: Commencez toujours par des étapes d'installation claires
2. Fournir la Configuration: Incluez les exigences de configuration spécifiques au plateau
3. Montrer des Exemples d'Utilisation: Fournissez des exemples de travail code
4. Inclure API Reference: Documenter toutes les méthodes et paramètres
5. Ajouter des Exemples Complets: Montrer des modèles d'utilisation dans le monde réel
6. Lister les Meilleures Pratiques: Partager des conseils pour un usage optimal
7. Documenter les Différences de Plateforme: Clarifier le comportement iOS par rapport à Android
8. Ajouter des Résolutions de Problèmes: Aborder les problèmes courants

Code Exemples

• Utilisez TypeScript pour tous les exemples de code
• Incluez les importations en haut
• Ajoutez des commentaires expliquant les étapes clés
• Montrez la gestion des erreurs
• Démontrer à la fois l'utilisation de base et avancée

Liste de vérification

Utilisez cette liste de vérification 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 bonne catégorie
• Ajouté une entrée de côté-bar dans /astro.config.mjs
• Créé un répertoire de documentation du plugin
• Créé index.mdx page d'aperçu
• Créé getting-started.mdx guide
• Créé un tutoriel dans /src/content/plugins-tutorials/en/
• Inclut des instructions d'installation
• Documenté la configuration iOS
• Documenté la configuration Android
• Fournit des exemples d'utilisation
• Ajouté une référence à API
• Exemple de travail complet inclus
• Pratiques recommandées listées
• Notes spécifiques au plateau ajoutées
• Tous les liens ont été testés pour fonctionner correctement

Référence des icônes

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

Icône	Utilisation
BoltIcon	Flash, puissance, énergie
CameraIcon	Caméra, photo, vidéo
ChatBubbleLeftIcon	Chat, messagerie, communication
FingerPrintIcon	Authentification biométrique, sécurité
MapPinIcon	Localisation, géolocalisation, cartes
SpeakerWaveIcon	Audio, son, musique
VideoCameraIcon	Vidéo, enregistrement, streaming
CreditCardIcon	Paiements, achats
PlayCircleIcon	Lecteurs multimédias, lecteurs vidéo
SignalIcon	Connectivité, réseau, balise
RadioIcon	Balise, diffusion, sans fil
ChatBubbleOvalLeftIcon	Réseaux sociaux, WeChat

Mise à jour des plugins existants

__CAPGO_KEEP_0__

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 du plateforme si elles ont changé
6. Réviser les meilleures pratiques en fonction de nouvelles fonctionnalités
7. Maintenez le tutoriel à jour avec les dernières API

Chemins de langue

Écrire et réviser les documents de plugin en anglais. Les chemins localisés sont générés par les métadonnées du site et traduits à l'extrémité 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érifiez que toutes les liens fonctionnent
   • Assurez-vous que les images chargent correctement
   • Confirmez que les exemples code sont valides
   • Testez la navigation

3. Prévisualisez le site:

   bun run dev

4. Vérifiez que votre plugin apparait:

   • Vérifiez la page de liste des plugins
   • Vérifiez la navigation du côté gauche
   • Testez toutes les pages de documentation
   • Confirmez 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. Nom incohérent : Utilisez le même nom de plugin partout
3. Configuration de plateforme manquante : Documentez à la fois la mise en place d'iOS et d'Android
4. Liens brisés: Utilisez des liens relatifs et vérifiez qu'ils fonctionnent
5. Aucun traitement d'erreurs: Affichez toujours un try-catch dans les exemples
6. Importations manquantes: Incluez 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 Communauté Discord
• GitHub: Ouvrez un problème sur le répertoire de dépôt du site web
• Courriel: Contactez l'équipe à support@capgo.app

Exemples

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

• Metteur à 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/ Résumé

Section intitulée “Résumé”

Adding a plugin to the Capgo documentation involves:

1. Ajouter le plugin à la page d'index de catégorisation
2. Configurer la navigation de côté
3. Créer des pages de documentation complètes
4. Adding a plugin to the __CAPGO_KEEP_0__ documentation involves:
5. Écrire un tutoriel détaillé
6. Tester toutes les modifications localement

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 avec Capgo Répertoire des plugins pour le flux de travail du produit dans Capgo Répertoire des plugins, Capacitor Plugins par Capgo pour les détails d'implémentation dans Capacitor Plugins par Capgo Alternatives de plugins d'entreprise Ionic pour le flux de travail du produit dans les alternatives de plugins d'entreprise Ionic, Capgo Construction native pour le flux de travail du produit dans Capgo Construction native, et Capacitor Plugins : Ce que vous devez savoir pour le contexte pratique dans Capacitor Plugins : Ce que vous devez savoir.