プラグインの追加または更新

このプラグインのインストールステップとフルマークダウンガイドまでの全てのステップを含む設定プロンプトをコピーする

This guide explains how to add new Capacitor plugins to the Capgo website or update existing plugin documentation. This is useful for contributors, maintainers, and AI agents helping to maintain the documentation.

概要

Capgo エコシステムに新しいプラグインを追加する場合、ウェブサイトのさまざまな場所に複数のファイルを更新する必要があります。そうすることで、プラグインがすべての関連する場所で正しく表示されるようにします。

プラグインリスト設定 - マスターリストにプラグインメタデータを追加する
プラグイン索引ページ - カテゴリごとのプラグインリストページにプラグインを追加する
サイドバーナビゲーション - ドキュメントサイドバーにプラグインを追加
プラグインドキュメント - オーバービューとスタートガイドページを作成
プラグインチュートリアル - 広範なチュートリアルを作成

ファイルの場所

更新する必要がある重要なファイル

ファイル	目的
`/src/config/plugins.ts`	プラグインのメタデータを含むマスターリスト
`/src/content/docs/docs/plugins/index.mdx`	プラグインインデックスページ
`/astro.config.mjs`	サイドバーナビゲーション設定
`/src/content/docs/docs/plugins/[plugin-name]/`	プラグインドキュメントディレクトリ
`/src/content/plugins-tutorials/en/`	英語チュートリアルファイル

ステップバイステップガイド

マスターリストにプラグインを追加

開く /src/config/plugins.ts 配列にあなたのプラグインを追加 actions 配列:

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

利用可能なアイコン：利用可能なアイコンを確認します。 /node_modules/astro-heroicons/mini/ インデックスページにプラグインを追加

セクション「インデックスページにプラグインを追加」
開き、適切なカテゴリの下でプラグインを追加してください。

クリップボードにコピー /src/content/docs/docs/plugins/index.mdx カテゴリ
```
<LinkCard
  title="Your Plugin Name"
  description="Brief description of what the plugin does"
  href="/docs/plugins/your-plugin-name/"
/>
```
📱 デバイス＆システムプラグイン:
- 🎥 メディア＆カメラプラグイン
- 📱 デバイス＆システムプラグイン、🎥 メディア＆カメラプラグイン、⭐ 人気のプラグイン、カテゴリのアイコンを表示します。
- 📱 デバイス＆システムプラグイン、🎥 メディア＆カメラプラグイン、⭐ 人気のプラグイン、カテゴリのアイコンを表示します。
- 🛠️ ユーティリティプラグイン
- 🤖 AI と高度なメディア
- 📍 場所とバックグラウンドサービス
- 📞 通信と分析
- 🔐 セキュリティとシステム
- 📊 Android固有の機能
- 📥 ダウンロードとナビゲーション
サイドバーナビゲーションに追加
「サイドバーナビゲーションに追加」

Open /astro.config.mjs サイドバーナビゲーションの設定 (約 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,
}
```
プラグインはアルファベット順にサイドバーに表示されます。
プラグインドキュメントディレクトリを作成
セクション「プラグインドキュメントディレクトリを作成」

プラグインドキュメント用の新しいディレクトリを作成してください:
ターミナル画面
```
mkdir -p /src/content/docs/docs/plugins/your-plugin-name/
```

コピー

セクション「プラグイン概要ページを作成」 /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>

コピー

作成 /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]

チュートリアルファイルを作成

作成 /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]

プラグインドキュメント構造

必要なファイル

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

任意のファイル

For complex plugins, you may add additional documentation pages:

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

Content Guidelines

Writing Plugin Descriptions

Be Concise: Keep descriptions under 100 characters
Be Specific: Explain what the plugin does, not what it is
Use Action Words: __CAPGO_KEEP_0__の動作を開始するには、「制御」、「統合」、「有効化」などの動詞を使用します。

良い例:

「デバイスのフラッシュライトとターチを単純なオン/オフのスイッチで制御する」
「クライアントのライブチャットと顧客サポートをアプリに統合する」
「Face IDとTouch IDを使用した安全な認証を有効化する」

悪い例:

「フラッシュ用のプラグイン」
「このはCrispプラグイン」
「バイオメトリックプラグイン」

ドキュメントの書き方

インストールから始める: インストールの手順から始める
提供する設定: プラットフォーム固有のセットアップ要件を含む
使用例を表示: 動作する code の例を提供する
API のリファレンスを含む: 全てのメソッドとパラメータをドキュメントする
完全な例を追加: 実世界での使用パターンを表示する
ベストプラクティスをリスト: 最適な使用方法に関するアドバイスを共有する
プラットフォーム間の差異をドキュメントする: iOS と Android の動作を明確にする
トラブルシューティングを追加する: 一般的な問題を解決する

Code の例

すべての code の例で TypeScript を使用する
トップに import を含める
重要なステップの説明を含める
エラー処理を示す
基本的な使用法と高度な使用法の両方を示す

チェックリスト

新しいプラグインを追加する際に使用するチェックリストを参照してください:

アイコン参照

プラグイン用に使用される一般的なアイコン ( astro-heroicons/mini/):

アイコン	使用例
`BoltIcon`	フラッシュ、電力、エネルギー
`CameraIcon`	カメラ、写真、ビデオ
`ChatBubbleLeftIcon`	チャット、メッセージング、コミュニケーション
`FingerPrintIcon`	バイオメトリクス、セキュリティ、認証
`MapPinIcon`	位置、地理位置、地図
`SpeakerWaveIcon`	オーディオ、サウンド、音楽
`VideoCameraIcon`	ビデオ、記録、ストリーミング
`CreditCardIcon`	決済、購入
`PlayCircleIcon`	メディアプレーヤー、ビデオプレーヤー
`SignalIcon`	接続性、ネットワーク、ビーコン
`RadioIcon`	ビーコン、ブロードキャスト、無線
`ChatBubbleOvalLeftIcon`	SNS、WeChat

既存のプラグインの更新

既存のプラグインを更新する場合:

バージョン番号を更新 ドキュメント
マイグレーションガイドを追加 破壊的な変更が存在する場合
APIの参照を更新 新しいメソッドとともに
新しい例を追加 新機能に基づいて
プラットフォームの要件を更新する 変更があれば
ベストプラクティスを修正する 新機能に基づいて
チュートリアルを最新の__CAPGO_KEEP_0__に合わせる 最新のAPIで

言語パス

英語でプラグインドキュメントを書き、レビューする。サイトメタデータによって生成されるローカライズされたパスは、エッジで翻訳ワーカーによって翻訳される。

変更をテストする

プラグインドキュメントを追加または更新した後:

サイトをローカルでビルドする:
ターミナルウィンドウ
```
bun run build
```
エラーを確認する:
- すべてのリンクが正常に動作することを確認する
- 画像が正しく表示されることを確認する
- codeの例が有効であることを確認する
- ナビゲーションが正常に動作することを確認する
サイトをプレビューする:
ターミナルウィンドウ
```
bun run dev
```
__CAPGO_KEEP_0__を確認する:
- __CAPGO_KEEP_1__のプラグインリストページを確認する
- __CAPGO_KEEP_0__のサイドバーナビゲーションを確認する
- すべてのドキュメントページをテストする
- チュートリアルページが正常に動作することを確認する

よくある間違い

ヘルプを求める

プラグインのドキュメントを追加または更新するのに必要な場合のヘルプを求めます:

Discord: 連絡先 Discordコミュニティ
GitHub: プラグインのドキュメントを追加または更新するのに必要な場合のヘルプを求めます。ウェブサイトのリポジトリに問題を提出する
メール: チームに連絡するサポート@capgo.app

例

参考として、以下のドキュメント化されたプラグインを確認してください:

アップデーター: /src/content/docs/docs/plugins/updater/ (複雑なプラグイン、複数のページあり)
フラッシュ: /src/content/docs/docs/plugins/flash/ (単純なプラグイン、スターター例として適しています)
ソーシャルログイン: /src/content/docs/docs/plugins/social-login/ (サブページを持つプラグイン)

概要

プラグインをCapgoドキュメントに追加するには:

マスター構成にメタデータを追加する
カテゴリ化されたインデックスページにプラグインを追加する
サイドバーのナビゲーションを設定する
包括的なドキュメントページを作成する
詳細なチュートリアルを書く
すべての変更をローカルでテストする

このガイドを遵守することで、プラグインはユーザーが容易に発見できるように、統一的にドキュメント化されます。