__CAPGO_KEEP_1__

このプラグインのインストール手順とフルマークダウンガイドを含むセットアップコマンドをコピーしてください。

インストール、同期、ソースマークダウンガイドを含む __CAPGO_KEEP_0__ プラグインを__CAPGO_KEEP_1__ ウェブサイトに追加する方法や既存のプラグインドキュメントを更新する方法について説明しています。このガイドはコントリビューター、メンテナー、ドキュメントを維持するために協力するAIエージェントにとても役立ちます。

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.

setup with 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 __CAPGO_KEEP_0__

{
  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を使用した安全な認証を有効にする」

Bad Examples:

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

Writing Documentation

Start with Installation:
: :
: : Provide working code examples
Include API Reference: __CAPGO_KEEP_0__ の使用方法を記載する
Add Complete Examples: 実際の使用例を示す
List Best Practices: 最適な使用方法を共有する
Document Platform Differences: iOS と Android の動作を明確にする
Add Troubleshooting: 一般的な問題を解決する

Code Examples

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

チェックリスト

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

アイコン参照

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

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

既存のプラグインの更新

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

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

言語パス

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

変更をテストする

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

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

よくある間違い

ヘルプを取得する

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

Discord: __CAPGO_KEEP_0__に参加してください Discordコミュニティ
GitHub: __CAPGO_KEEP_0__のウェブサイトリポジトリにissueを提出してくださいウェブサイトリポジトリ
メール: __CAPGO_KEEP_0__.appのサポートチームに連絡してください support@capgo.app

例

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

アップデーター: /src/content/docs/docs/plugins/updater/ 複雑なプラグイン（複数のページ）
Flash: /src/content/docs/docs/plugins/flash/ 単純なプラグイン（初心者向けの例）
ソーシャルログイン: /src/content/docs/docs/plugins/social-login/ 概要

「概要」のセクション

Adding a plugin to the Capgo documentation involves:

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

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

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

__CAPGO_KEEP_0__ を使用している場合 __CAPGO_KEEP_0__ プラグインを追加または更新する __CAPGO_KEEP_0__ プラグインディレクトリと接続する Capgo プラグインディレクトリの製品ワークフロー Capgo プラグイン Capgo によって Capacitor プラグイン for the implementation detail in Capacitor Plugins by Capgo, Ionic Enterprise プラグイン代替 Ionic Enterprise プラグイン代替の製品ワークフローについて Capgo ネイティブビルド Capgo ネイティブビルドの製品ワークフローについて Capacitor プラグイン: ご覧になる必要なこと Capacitor プラグイン: ご覧になる必要なことの実用的な背景

__CAPGO_KEEP_1__

setup with AI

ファイルの場所

更新する必要があるキーファイル

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

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

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

サイドバー ナビゲーションに追加

プラグインドキュメントディレクトリを作成

プラグインの概要ページを作成

はじめにガイドを作成

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

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

必要なファイル

オプションファイル

コンテンツガイドライン

プラグインの説明を書く

Writing Documentation

Code Examples

チェックリスト

アイコン参照

既存のプラグインの更新

言語パス

変更をテストする

よくある間違い

ヘルプを取得する

例

「概要」のセクション

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

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

サイドバーナビゲーションに追加