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

インストール手順とこのプラグインの全マークダウンガイドを含む設定プロンプトをコピーします。

このガイドでは、Capacitor プラグインを Capgo ウェブサイトに追加したり既存のプラグインドキュメントを更新したりする方法を説明します。このガイドは、コントリビューター、メンテナー、およびドキュメントの維持に協力するAIエージェント向けに便利です。

概要

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

- マスターリストにプラグインメタデータを追加 - プラグインリストの構成
プラグインインデックスページ - カテゴリごとにプラグインをリスト表示するページにプラグインを追加する
サイドバーナビゲーション - ドキュメントサイドバーにプラグインを追加する
プラグインドキュメント - オーバービューとスタートガイドページを作成する
プラグインチュートリアル - 統合的なチュートリアルを作成する

ファイルの場所

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

ファイル	目的
`/src/config/plugins.ts`	__CAPGO_KEEP_0__のメタデータを含むプラグインの一覧
`/src/content/docs/docs/plugins/index.mdx`	__CAPGO_KEEP_0__のカテゴリ別プラグイン一覧
`/astro.config.mjs`	__CAPGO_KEEP_0__のナビゲーション設定
`/src/content/docs/docs/plugins/[plugin-name]/`	__CAPGO_KEEP_0__のドキュメントディレクトリ
`/src/content/plugins-tutorials/en/`	英語版チュートリアルファイル

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

__CAPGO_KEEP_0__をマスターリストに追加

開く /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/"
/>
```
array: __CAPGO_KEEP_0__:
- ⭐ 代表的なプラグイン
- 📱 デバイス & システムプラグイン
- 🎥 メディア & カメラプラグイン
- 🛠️ ユーティリティプラグイン
- 🤖 AI & アドバンストメディア
- 📍 ロケーション & バックグラウンドサービス
- 📞 通信 & アナリティクス
- 🔐 セキュリティ & システム
- 📊 Android固有の機能
- 📥 ダウンロード & ナビゲーション
サイドバーナビゲーションに追加
「サイドバーナビゲーションに追加」

開く /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

オプションファイル

複雑なプラグインの場合、追加のドキュメントページを追加できます:

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

コンテンツガイドライン

プラグインの説明を書く

簡潔に: 100文字以内に説明を抑え
具体化してください: プラグインの機能を説明するのではなく、そのプラグイン自体を説明しないでください
アクションワードを使ってください: 「制御する」、「統合する」、「有効にする」などの動詞から始めてください

良い例:

“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”

Bad Examples:

“A plugin for flash”
“This is a Crisp plugin”
“Biometric plugin”

ドキュメントの作成

インストールから始める:明確なインストール手順から始める
設定を提供する:プラットフォーム固有のセットアップ要件を含める
使用例を表示する:実行可能なcode例を提供する
APIリファレンスを含める:すべてのメソッドとパラメータをドキュメントする
完全な例を追加する:現実世界の使用パターンを示す
List Best Practices: 最適な使用方法のヒントを共有する
Document Platform Differences: iOS と Android の動作を明確にする
Add Troubleshooting: 一般的な問題を解決する

Code Examples

Use TypeScript for all code examples
__CAPGO_KEEP_0__ の例では TypeScript を使用する
Include imports at the top
__CAPGO_KEEP_0__ の例では、トップに import を含めるようにすること。
基本と高度な使用法の両方を示す

チェックリスト

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

アイコンリファレンス

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

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

既存のプラグインの更新

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

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

言語パス

英語でプラグインドキュメントを書き、レビューする。

変更をテストする

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

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

よくある間違い

ヘルプ

プラグインの追加または更新のドキュメントを追加する必要がある場合:

Discord: 連絡先 Discordコミュニティ
: GitHub: __CAPGO_KEEP_0__ ウェブサイトリポジトリ
メール: チームに連絡するサポート: support@capgo.app

例

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

アップデーター: /src/content/docs/docs/plugins/updater/ (複雑なプラグイン、複数のページあり)
フラッシュ: /src/content/docs/docs/plugins/flash/ (シンプルなプラグイン、良好なスターター例)
ソーシャルログイン: /src/content/docs/docs/plugins/social-login/ (プラグインと子ページ)

概要

Capgo ドキュメントにプラグインを追加するには、以下の手順を実行します。

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

このガイドを実行することで、プラグインは一貫してドキュメントされ、ユーザーが容易に発見できるようになります。