プラグインを追加または更新する

インストール手順とこのプラグインの全マークダウンガイドを含むセットアッププロンプトをコピー

このガイドでは、Capacitor プラグインをCapgo ウェブサイトに追加する方法や既存のプラグインドキュメントを更新する方法について説明します。これは、ドキュメントの維持に協力するコントリビューター、メンテナー、AIエージェントにとって役立ちます。

概要

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/"
/>
```
Categories:
- ⭐ 代表的なプラグイン
- 📱 デバイス & システムプラグイン
- 🎥 メディア & カメラプラグイン
- 🛠️ ユーティリティプラグイン
- 🤖 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文字以内でなければなりません必要なファイルのセクション
具体に述べる: プラグインの機能を説明するのではなく、そのプラグイン自体を説明するのではなく
動詞を使う: 「制御する」、「統合する」、「有効にする」などの動詞から始める

良い例:

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

悪い例:

「フラッシュ用のプラグイン」
「クライスプラグインである」
「生物学的プラグイン」

ドキュメントの作成

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

Code Examples

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

チェックリスト

新しいプラグインを追加する際に使用するチェックリストです

アイコンリファレンス

プラグインでよく使われるアイコン ( astro-heroicons/mini/):

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

既存のプラグインの更新

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

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

with new methods

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

変更をテストする

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

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

よくある間違い

ヘルプを求める

プラグインの追加または更新のドキュメントの作成に必要な場合:

Discord: ご参加ください Discordコミュニティ
GitHub: GitHubのissueに新規作成するサイトリポジトリ
メールアドレス: チームに連絡するサポート@capgo.app

例

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

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

概要

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

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

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

「プラグインの追加または更新」を続けてください

Capgoを使用している場合 プラグインの追加または更新 Capgoを使用してネイティブプラグインの作業を計画する場合、__CAPGO_KEEP_0__ プラグインディレクトリと接続します。 Capgo プラグインディレクトリの製品ワークフロー Capgo プラグインの__CAPGO_KEEP_1__ Capacitor プラグインのCapgoの実装詳細 for the implementation detail in Capacitor Plugins by Capgo, Ionic Enterprise プラグインの代替の製品ワークフロー __CAPGO_KEEP_0__ ネイティブビルド Capgo ネイティブビルドの製品ワークフロー for the product workflow in Capgo Native Builds, and Capacitor プラグイン: 重要な事項 Capgoプラグイン: Capacitor プラグイン: 重要な事項の実用的な文脈