Ajouter ou mettre à jour des plugins
Copiez un prompt de configuration incluant les étapes d'installation et le guide markdown complet pour ce plugin.
Ce guide explique comment ajouter de nouveaux plugins Capacitor au site web Capgo ou mettre à jour la documentation des plugins existants. C’est utile pour les contributeurs, les mainteneurs et les agents IA qui aident à maintenir la documentation.
Lors de l’ajout d’un nouveau plugin à l’écosystème Capgo, vous devez mettre à jour plusieurs fichiers et emplacements sur le site web afin que le plugin s’affiche correctement dans tous les endroits pertinents :
- Configuration de la liste des plugins - Ajouter les métadonnées du plugin à la liste principale
- Page d’index des plugins - Ajouter le plugin à la page de liste des plugins par catégorie
- Navigation latérale - Ajouter le plugin à la barre latérale de la documentation
- Documentation du plugin - Créer les pages d’aperçu et de démarrage
- Tutoriel du plugin - Créer un tutoriel complet
Emplacements des fichiers
Section intitulée « Emplacements des fichiers »Fichiers clés à mettre à jour
Section intitulée « Fichiers clés à mettre à jour »| Fichier | Objectif |
|---|---|
/src/config/plugins.ts | Liste principale des 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 la navigation latérale |
/src/content/docs/docs/plugins/[plugin-name]/ | Répertoire de la documentation des plugins |
/src/content/plugins-tutorials/en/ | Fichiers du tutoriel en anglais |
Guide étape par étape
Section intitulée « Guide étape par étape »-
Ajouter le plugin à la liste principale
Section intitulée « Ajouter le plugin à la liste principale »Ouvrez
/src/config/plugins.tset ajoutez votre plugin auactionstableau :// 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,}Icônes disponibles : Vérifier
/node_modules/astro-heroicons/mini/pour les icônes disponibles. -
Ajouter le plugin à la page d'index
Section intitulée « Ajouter un plugin à la page d’index »Ouvrez
/src/content/docs/docs/plugins/index.mdxet ajoutez votre plugin sous la catégorie appropriée :<LinkCardtitle="Your Plugin Name"description="Brief description of what the plugin does"href="/docs/plugins/your-plugin-name/"/>Catégories:
- ⭐ Plugins en vedette
- 📱 Plugins appareil & système
- 🎥 Plugins média & caméra
- 🛠️ Plugins utilitaires
- 🤖 IA et médias avancés
- 📍 Localisation et services en arrière-plan
- 📞 Communication et analytics
- 🔐 Sécurité et système
- 📊 Fonctionnalités spécifiques à Android
- 📥 Téléchargement et navigation
-
Ajouter à la navigation latérale
Section intitulée « Ajouter à la navigation latérale »Ouvrez
/astro.config.mjset ajoutez votre plugin à la configuration de la barre latérale (vers la 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,}Plugins are listed alphabetically in the sidebar.
-
Créer le répertoire de documentation du plugin
Section intitulée « Créer le répertoire de documentation du plugin »Créez un nouveau répertoire pour la documentation de votre plugin :
Fenêtre de terminal mkdir -p /src/content/docs/docs/plugins/your-plugin-name/ -
Créer la page de présentation du plugin
Section intitulée « Créer la page de présentation 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 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> -
Créer le guide de démarrage
Section intitulée « Créer le guide de démarrage »Créer
/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] -
Créer le fichier de tutoriel
Section intitulée « Créer un fichier de tutoriel »Créer
/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]
Structure de la documentation du plugin
Section intitulée « Structure de la documentation des plugins »Fichiers requis
Section intitulée « 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 tutorialFichiers optionnels
Section intitulée « 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 guidesRègles de contenu
Section intitulée « Directives de contenu »Rédiger les descriptions de plugins
Section intitulée « Rédiger les descriptions de plugins »- Soyez concis: Gardez les descriptions sous les 100 caractères
- Soyez précis: Expliquez ce que le plugin fait, pas ce qu’il est
- Utilisez des verbes d’action: Commencez par des verbes comme « Control », « Integrate », « Enable »
Bonnes pratiques:
- « Control device flashlight and torch with simple on/off toggle »
- « Integrate Crisp live chat and customer support into your app »
- « Enable secure authentication using Face ID and Touch ID »
Mauvaises pratiques:
- « A plugin for flash »
- « This is a Crisp plugin »
- « Biometric plugin »
Rédiger la documentation
Section intitulée « Writing Documentation »- Commencez par l’installation: Commencez toujours par des étapes d’installation claires
- Fournir la configuration: Inclure les prérequis de configuration par plateforme
- Afficher des exemples d'utilisation: Fournir des exemples code fonctionnels
- Inclure la référence API: Documenter toutes les méthodes et paramètres
- Ajouter des exemples complets: Montrer des cas d'usage réels
- Lister les bonnes pratiques: Partager des conseils pour une utilisation optimale
- Documenter les différences entre plateformes: Clarifier le comportement iOS vs Android
- Ajouter une section de dépannage: Résoudre les problèmes courants
Exemples Code
Section intitulée « Exemples Code »- Utiliser TypeScript pour tous les exemples code
- Inclure les imports en haut
- Add comments explaining key steps
- Montrer la gestion des erreurs
- Démontrer l’usage basique et avancé
Checklist
Section intitulée « Checklist »Use this checklist when adding a new plugin:
- Plugin ajouté à
/src/config/plugins.ts - Icône appropriée sélectionnée dans Heroicons
- Plugin ajouté à
/src/content/docs/docs/plugins/index.mdxsous la bonne catégorie - Entrée de la barre latérale ajoutée dans
/astro.config.mjs - Répertoire de documentation du plugin créé
- Créé
index.mdxpage de présentation - Créé
getting-started.mdxguide - Tutoriel créé dans
/src/content/plugins-tutorials/en/ - Instructions d'installation incluses
- Configuration iOS documentée
- Configuration Android documentée
- Exemples d’utilisation fournis
- Référence API ajoutée
- Exemple complet et fonctionnel inclus
- Bonnes pratiques listées
- Notes spécifiques à la plateforme ajoutées
- Tous les liens testés et fonctionnels
Référence des icônes
Section intitulée « Référence des icônes »Icônes couramment utilisées pour les plugins (depuis astro-heroicons/mini/):
| Icône | Cas d’usage |
|---|---|
BoltIcon | Flash, alimentation, é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 | Lecteurs multimédias, lecteurs vidéo |
SignalIcon | Connectivité, réseau, balise |
RadioIcon | Balise, diffusion, sans fil |
ChatBubbleOvalLeftIcon | Réseaux sociaux, WeChat |
Mettre à jour des plugins existants
Section intitulée « Mise à jour des plugins existants »Lors de la mise à jour d'un plugin existant :
- Mettre à jour les numéros de version dans la documentation
- Ajouter des guides de migration s'il y a des breaking changes
- Mettre à jour la référence API avec les nouvelles méthodes
- Ajouter de nouveaux exemples pour les nouvelles fonctionnalités
- Mettre à jour les prérequis plateforme si modifié
- Réviser les bonnes pratiques en fonction des nouvelles fonctionnalités
- Garder le tutoriel à jour avec la dernière version de API
Chemins des langues
Section intitulée « Chemins de langue »Rédigez et relisez la documentation des plugins en anglais. Les chemins localisés sont générés par les métadonnées du site et traduits à l’edge par le Worker de traduction.
Tester vos modifications
Section intitulée « Tester vos modifications »Après avoir ajouté ou mis à jour la documentation d’un plugin :
-
Compiler le site localement:
Fenêtre de terminal bun run build -
Vérifier les erreurs:
- Vérifier que tous les liens fonctionnent
- S'assurer que les images se chargent correctement
- Confirmer que les exemples code sont valides
- Tester la navigation
-
Prévisualiser le site:
Fenêtre de terminal bun run dev -
Vérifier que votre plugin apparaît:
- Vérifier la page de listing des plugins
- Vérifier la navigation latérale
- Tester toutes les pages de documentation
- Vérifier que la page du tutoriel fonctionne
Erreurs courantes
Section intitulée « Pièges courants »Obtenir de l'aide
Section intitulée « Obtenir de l'aide »Besoin d’aide pour ajouter ou mettre à jour la documentation d’un plugin ?
- Discord: Rejoignez notre communauté Discord
- GitHub: Ouvrez une issue sur le dépôt du site web
- E-mail: Contactez l'équipe sur support@capgo.app
Exemples
Section intitulée « Exemples »Pour référence, consultez ces plugins bien documentés :
- Updater:
/src/content/docs/docs/plugins/updater/(plugin complexe avec plusieurs pages) - Flash:
/src/content/docs/docs/plugins/flash/(plugin simple, bon exemple de départ) - Connexion sociale:
/src/content/docs/docs/plugins/social-login/(plugin avec sous-pages)
L’ajout d’un plugin à la documentation Capgo implique :
- Ajout de métadonnées à la configuration principale
- Ajouter le plugin à la page d'index par catégories
- Configuration de la navigation latérale
- Créer des pages de documentation complètes
- Rédiger un tutoriel détaillé
- Tester tous les changements en local
En suivant ce guide, vous garantissez que les plugins sont documentés de manière cohérente et facilement trouvables par les utilisateurs.
Continuer après l'ajout ou la mise à jour de plugins
Section intitulée « Continuer après l'ajout ou la mise à jour de plugins »Si vous utilisez Ajouter ou mettre à jour des plugins pour planifier le travail sur les plugins natifs, connectez-l’à Capgo Répertoire des plugins pour le workflow produit dans Capgo Plugin Directory, Plugins Capacitor par Capgo pour les détails d'implémentation dans Plugins Capacitor par Capgo, Alternatives aux plugins Ionic Enterprise pour le workflow produit dans les alternatives aux plugins Ionic Enterprise, Capgo Native Build pour le flux de travail du produit dans Capgo Native Builds, et Plugins Capacitor : ce que vous devez savoir pour le contexte pratique dans Capacitor Plugins : ce qu'il faut savoir.