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

コピー用の設定

このガイドでは、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/"
/>
```
カテゴリ:
- ⭐ 人気のプラグイン
- 📱 デバイス & システムプラグイン
- 🎥 メディア & カメラプラグイン
- 🛠️ ユーティリティプラグイン
- 🤖 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」、「Integrate」、「Enable」

良い例:

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

Bad Examples:

「フラッシュ用のプラグイン」
“Capgo プラグインです”
「バイオメトリックプラグイン」

ドキュメントの作成

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

Codeの例

codeの例では、すべてのTypeScriptを使用する
トップにインポートを追加する
重要なステップを説明するコメントを追加する
エラー処理を示す
基本的な使用法と高度な使用法の両方を示す

チェックリスト

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

アイコン参照

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

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

既存のプラグインの更新

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

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

言語パス

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

変更をテストする

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

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

よくある間違い

ヘルプを求める

プラグインの追加または更新のドキュメントについての助けが必要な場合:

: 以下のDiscordコミュニティ __CAPGO_KEEP_0__
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/ (プラグイン、サブページあり)

(プラグイン、サブページあり)

Adding a plugin to the Capgo documentation involves:

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

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

続けてAdding or Updating Plugins

Capgoを使用している場合 プラグインの追加または更新 native プラグインの作業を計画するには、 Capgo プラグインディレクトリ製品ワークフローにおける Capgo プラグインディレクトリ Capacitor プラグインの Capgo 製品ワークフローにおける Capacitor プラグインの Capgo イオニックエンタープライズプラグインの代替製品ワークフローにおけるイオニックエンタープライズプラグインの代替 Capgo ネイティブビルド製品ワークフローにおける Capgo ネイティブビルド、 Capacitor プラグイン: 必要な事項実用的な文脈における Capacitor プラグイン: 必要な事項