Hinzufügen oder Aktualisieren von Plugins

Kopieren Sie eine Setup-Anregung mit den Installationsanweisungen und der vollständigen Markdown-Guideline für diesen Plugin.

Diese Anleitung erklärt, wie Sie neue Capacitor-Plugins für die Capgo-Website hinzufügen oder bestehende Plugin-Dokumentation aktualisieren können. Dies ist nützlich für Beiträger, Maintainer und KI-Agenten, die dabei helfen, die Dokumentation zu pflegen.

Übersicht

Wenn Sie ein neues Plugin in das Capgo-Ökosystem einfügen, müssen Sie mehrere Dateien und Orte auf der Website aktualisieren, um sicherzustellen, dass das Plugin in allen relevanten Bereichen korrekt angezeigt wird:

Einstellungen für die Plugin-Liste - Hinzufügen von Plugin-Metadaten zur Masterliste
Plugin-Index-Seite - Plugin zur Kategorisierten Plugin-Übersicht hinzufügen
Naviertabelle - Plugin zur Seitenleiste hinzufügen
Plugin-Dokumentation - Übersichts- und Anfänger-Seiten erstellen
Plugin-Tutorial - Ausführliches Tutorial erstellen

Dateilocationen

Wichtige Dateien aktualisieren

Datei	Zweck
`/src/config/plugins.ts`	__CAPGO_KEEP_0__ Liste mit Metadaten
`/src/content/docs/docs/plugins/index.mdx`	__CAPGO_KEEP_0__ Indexseite mit Kategorien
`/astro.config.mjs`	__CAPGO_KEEP_0__ Konfiguration der Seitenleiste
`/src/content/docs/docs/plugins/[plugin-name]/`	__CAPGO_KEEP_0__ Verzeichnis für Plugin-Dokumentation
`/src/content/plugins-tutorials/en/`	__CAPGO_KEEP_0__ Englische Tutorial-Dateien

__CAPGO_KEEP_0__ Schritt-für-Schritt-Anleitung

__CAPGO_KEEP_0__ Plugin zur Masterliste hinzufügen

Open /src/config/plugins.ts und fügen Sie Ihr Plugin zur 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,
}

Verfügbare Icons: Überprüfen /node_modules/astro-heroicons/mini/ Für verfügbare Icons.

Hinzufügen zum Index-Seiten
Abschnitt: Hinzufügen zum Index-Seiten

Öffnen /src/content/docs/docs/plugins/index.mdx und fügen Sie Ihr Plugin unter der entsprechenden Kategorie ein:
```
<LinkCard
  title="Your Plugin Name"
  description="Brief description of what the plugin does"
  href="/docs/plugins/your-plugin-name/"
/>
```
Kategorien:
- ⭐ Hervorhebungsplugins
- 📱 Geräte- & System-Plugins
- 🎥 Medien- & Kamera-Plugins
- 🛠️ Werkzeug-Plugins
- 🤖 KI- & Advanced-Media
- 📍 Standort- & Hintergrunddienste
- 📞 Kommunikation- & Analytics
- 🔐 Sicherheit- & System
- 📊 Android-Spezifische Funktionen
- 📥 Download- & Navigation
Zum Seitenleisten-Navigation hinzufügen
Seite mit dem Titel “Zum Seitenleisten hinzufügen”

Öffnen /astro.config.mjs und fügen Sie Ihre Erweiterung der Seitenleiste-Konfiguration (um die Zeile 540 herum) hinzu:
```
{
  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,
}
```
Die Erweiterungen werden alphabetisch in der Seitenleiste aufgelistet.
Erweiterungsdokumentationsverzeichnis erstellen
Abschnitt mit dem Titel „Erweiterungsdokumentationsverzeichnis erstellen“

Erstellen Sie ein neues Verzeichnis für die Dokumentation Ihrer Erweiterung:
Terminalfenster
```
mkdir -p /src/content/docs/docs/plugins/your-plugin-name/
```

Erweiterungsvorstellungsbildschirm erstellen

Erstellen /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>

Werden Sie eine Anleitung erstellen

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

Erstellen Sie eine Tutorial-Datei

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

Struktur der Plugin-Dokumentation

Benötigte Dateien

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

Zusätzliche Dateien

Für komplexe Plugins können Sie zusätzliche Dokumentationsseiten hinzufügen:

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

Inhaltliche Richtlinien

Pluginbeschreibungen schreiben

Sei knapp: Halten Sie Beschreibungen unter 100 Zeichen
Sei spezifisch: Erklären Sie, was das Plugin tut, nicht was es ist
Verwenden Sie Handlungsverben: Beginnen Sie mit Verben wie “Steuerung”, “Integrieren”, “Aktivieren”

Gute Beispiele:

Steuerung des Geräte-Blitzlichts und der Taschenlampe mit einfacher Ein/Aus-Schaltfläche
“Integrieren Sie Crisp-Lebenslauf-Chat und Kundenunterstützung in Ihre App”
“Aktivieren Sie sichere Authentifizierung mit Face ID und Touch ID”

Schlechte Beispiele:

“Ein Blitzlicht-Plugin”
“Dies ist ein Crisp-Plugin”
“Ein Biometrie-Plugin”

Die Erstellung von Dokumentation

Mit der Installation beginnen: Beginne immer mit klaren Installationsanweisungen
Konfiguration bereitstellen: Füge Plattform-spezifische Einrichtungsanforderungen hinzu
Verwendung beispiel zeigen: Biete funktionierende code Beispiele an
Referenz API einfügen: Dokumentiere alle Methoden und Parameter
Vollständige Beispiele hinzufügen: Zeige realistische Verwendungsmuster an
Best Practices auflisten: Teile Tipps für eine optimale Nutzung
Dokumentiere Plattformunterschiede: Kläre das Verhalten von iOS gegenüber Android
Hinzufügen von Fehlersuche: Beantworte häufige Probleme

Code Beispiele

Verwende TypeScript für alle code Beispiele
Fügen Sie Importe am Anfang hinzu
Hinzufügen von Kommentaren zu wichtigen Schritten
Zeige Fehlerbehandlung
Demonstrate both basic and advanced usage

Übersicht

Verwenden Sie diese Liste, wenn Sie ein neues Plugin hinzufügen.

Icon-Referenz

Verwendete Icons für Plugins (von astro-heroicons/mini/):

Icon	Verwendung
`BoltIcon`	Leistung, Energie, Blitz
`CameraIcon`	Blitz, Energie, Strom
`ChatBubbleLeftIcon`	Chat, Messaging, Kommunikation
`FingerPrintIcon`	Chat, Nachrichten, Kommunikation
`MapPinIcon`	Biometrie, Sicherheit, Authentifizierung
`SpeakerWaveIcon`	Ort, Standort, Karte
`VideoCameraIcon`	Video, recording, streaming
`CreditCardIcon`	Video, Aufzeichnung, Streaming
`PlayCircleIcon`	Multimedia-Player, Video-Player
`SignalIcon`	Verbindung, Netzwerk, Beacon
`RadioIcon`	Beacon, Übertragung, drahtlos
`ChatBubbleOvalLeftIcon`	Soziale Medien, WeChat

Aktualisierung bestehender Plugins

Wenn Sie ein bestehendes Plugin aktualisieren:

Aktualisieren Sie die Versionsnummern in der Dokumentation
Fügen Sie Anleitungen zur Migration hinzu wenn sich die Änderungen als bruchstückhaft erweisen
Aktualisieren Sie die API-Referenz mit neuen Methoden
Neue Beispiele hinzufügen für neue Funktionen
Plattformanforderungen aktualisieren wenn geändert
Best Practices überarbeiten basierend auf neuen Funktionen
Tutorial auf dem neuesten Stand halten mit den neuesten API

Sprachpfade

Schreiben und überprüfen Sie Plugin-Dokumentation in Englisch. Lokalisierte Pfade werden durch die Site-Metadaten generiert und an der Edge durch den Übersetzungsdienst übersetzt.

Ihre Änderungen testen

After adding or updating plugin documentation:

Die Website lokal erstellen:
Terminalfenster
```
bun run build
```
Fehler überprüfen:
- Überprüfen, ob alle Links funktionieren
- Stellen Sie sicher, dass Bilder korrekt geladen werden
- Bestätigen Sie, dass code Beispiele gültig sind
- Überprüfen Sie, ob die Navigation funktioniert
Vorschau der Website:
Terminalfenster
```
bun run dev
```
Überprüfen Sie, ob Ihr Plugin erscheint:
- Überprüfen Sie die Plugin-Listenseite
- Überprüfen Sie die Seitenleiste
- Testen Sie alle Dokumentationsseiten
- Bestätigen Sie, dass die Tutorialseite funktioniert

Häufige Falle

Hilfe erhalten

If you need help adding or updating plugin documentation:

DiscordBeteilige dich an Discord-Community
GitHubÖffnen Sie ein Issue auf der Website-Repository
Email: Kontaktiere das Team bei support@capgo.app

Beispiele

Zu Referenzzwecken überprüfen Sie diese gut dokumentierten Plugins:

Updater: /src/content/docs/docs/plugins/updater/ (komplexer Plugin mit mehreren Seiten)
Flash: /src/content/docs/docs/plugins/flash/ (einfaches Plugin, gute Anfangsbeispiel)
Soziale Anmeldung: /src/content/docs/docs/plugins/social-login/ (Plugin mit Unterseiten)

Zusammenfassung

Das Hinzufügen eines Plugins zur Capgo Dokumentation umfasst:

Hinzufügen von Metadaten zur Master-Konfiguration
Hinzufügen des Plugins zur kategoriellen Indexseite
Konfigurieren der Seitenleiste
Erstellen umfassender Dokumentationsseiten
Schreiben eines detaillierten Tutorials
Testen aller Änderungen lokal

Indem Sie diese Anleitung befolgen, stellen Sie sicher, dass Plugins konsistent dokumentiert und leicht von Benutzern auffindbar sind.

Fortsetzen mit dem Hinzufügen oder Aktualisieren von Plugins

If Sie ein Plugin verwenden Hinzufügen oder Aktualisieren von Plugins um native Plugin-Arbeit zu planen, verbinden Sie es mit Capgo Plugin-Verzeichnis für den Produktworkflow in Capgo Plugin-Verzeichnis Capacitor Plugins durch Capgo um Details zur Implementierung in Capacitor Plugins durch Capgo Ionische Unternehmens-Plugin-Alternativen um den Produktworkflow in Ionischen Unternehmens-Plugin-Alternativen Capgo Native Builds um den Produktworkflow in Capgo Native Builds und Capacitor Plugins: Was Sie wissen müssen für den praktischen Kontext in Capacitor Plugins: Was Sie wissen müssen.

Hinzufügen oder Aktualisieren von Plugins

Übersicht

Dateilocationen

Wichtige Dateien aktualisieren

__CAPGO_KEEP_0__ Schritt-für-Schritt-Anleitung

__CAPGO_KEEP_0__ Plugin zur Masterliste hinzufügen

Hinzufügen zum Index-Seiten

Zum Seitenleisten-Navigation hinzufügen

Erweiterungsdokumentationsverzeichnis erstellen

Erweiterungsvorstellungsbildschirm erstellen

Werden Sie eine Anleitung erstellen

Erstellen Sie eine Tutorial-Datei

Struktur der Plugin-Dokumentation

Benötigte Dateien

Zusätzliche Dateien

Inhaltliche Richtlinien

Pluginbeschreibungen schreiben

Die Erstellung von Dokumentation

Code Beispiele

Übersicht

Icon-Referenz

Aktualisierung bestehender Plugins

Sprachpfade

Ihre Änderungen testen

Häufige Falle

Hilfe erhalten

Beispiele

Zusammenfassung

Fortsetzen mit dem Hinzufügen oder Aktualisieren von Plugins