添加或更新插件

本指南解释了如何将新 Capacitor 插件添加到 Capgo 网站或更新现有插件文档。这对贡献者、维护者和帮助维护文档的 AI agent 都很有用。

概述

当添加新插件到 Capgo 生态系统时，您需要更新网站上的多个文件和位置，以确保插件在所有相关位置都正确显示:

1. 插件列表配置 - 将插件元数据添加到主列表
2. 插件索引页面 - 将插件添加到分类的插件列表页面
3. 侧边栏导航 - 将插件添加到文档侧边栏
4. 插件文档 - 创建概述和快速入门页面
5. 插件教程 - 创建全面教程

文件位置

需要更新的关键文件

文件	目的
/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/	英文教程文件

逐步指南

1. 打开

   __CAPGO_KEEP_0__ /src/config/plugins.ts __CAPGO_KEEP_1__ actions array:

   // 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/ 查看可用图标。

2. 将插件添加到首页

   打开 /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-专属功能
   • 📥 下载 & 导航

3. 添加到侧边栏导航

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

   在侧边栏中按字母顺序列出插件。

4. 创建插件文档目录

   为您的插件文档创建一个新目录：

   mkdir -p /src/content/docs/docs/plugins/your-plugin-name/

5. 创建插件概览页面

   创建 /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>

6. 创建开始使用指南

   创建 /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]

7. 创建教程文件

   创建 /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个字符具体
• 保留原样: 描述该插件的功能，而不是它是什么
• 使用动词: 以“控制”，“整合”，“启用”等动词开始

好的例子:

• “使用简单的开关控制设备的闪光灯和手电筒”
• “将 Crisp 的实时聊天和客户支持整合到您的应用中”
• “使用 Face ID 和 Touch ID 启用安全认证”

坏的例子:

• “用于闪光灯的插件”
• “这是一个 Crisp 插件”
• “生物识别插件”

编写文档

1. 开始安装:始终以清晰的安装步骤开始
2. 提供配置:包含平台特定的设置要求
3. 展示使用示例: Provide working code examples
4. Include API Reference:记录所有方法和参数
5. 添加完整示例:展示真实世界的使用模式
6. 列出最佳实践: 最佳实践使用技巧
7. 文档平台差异: iOS 和 Android 行为的区别
8. 添加故障排除: 常见问题

Code 示例

• 使用 TypeScript 为所有 code 示例
• 在顶部包含导入
• 添加解释关键步骤的注释
• 显示错误处理
• 演示基本和高级使用

检查清单

在添加新插件时，请使用此检查清单:

• 将插件添加到 /src/config/plugins.ts
• 从 Heroicons 中选择了合适的图标
• 将插件添加到 /src/content/docs/docs/plugins/index.mdx 在正确的类别下
• 在侧边栏中添加了插件条目 /astro.config.mjs
• 创建了插件文档目录
• 创建了 index.mdx 概述页面
• 创建了 getting-started.mdx 指南
• 创建了教程 /src/content/plugins-tutorials/en/
• 包含了安装说明
• 文档了iOS配置
• 文档了Android配置
• 提供了使用示例
• 添加了API参考
• 包含了完整的工作示例
• 列出了最佳实践
• 添加了平台特定说明
• 测试了所有链接正确工作

图标参考

常用插件图标（来自 astro-heroicons/mini/):

Icon	使用场景
BoltIcon	闪光，电力，能源
CameraIcon	摄像头，照片，视频
ChatBubbleLeftIcon	聊天，信息，沟通
FingerPrintIcon	生物识别，安全，身份验证
MapPinIcon	位置，地理位置，地图
SpeakerWaveIcon	音频，声音，音乐
VideoCameraIcon	视频，录制，流媒体
CreditCardIcon	支付，购买
PlayCircleIcon	多媒体播放器, 视频播放器
SignalIcon	连接, 网络, 蓝牙
RadioIcon	蓝牙, 广播, 无线
ChatBubbleOvalLeftIcon	社交媒体, 微信

更新现有插件

更新现有插件时：

1. 更新版本号 在文档中
2. 添加迁移指南 如果存在破坏性更改
3. 更新API引用 与新方法
4. 添加新示例 为新功能
5. 更新平台要求 如果改变
6. 修订最佳实践 基于新功能
7. 保持教程最新 与最新API

语言路径

以英文编写和审阅插件文档。 本地化路径由站点元数据生成并在边缘由翻译工人翻译。

测试您的更改

添加或更新插件文档后:

1. 本地构建站点:

   bun run build

2. 检查错误:

   • 验证所有链接正常工作
   • 确保图片加载正确
   • 确认code示例有效
   • 测试导航

3. 预览站点:

   bun run dev

4. 确认插件已显示:

   • 检查插件列表页面
   • 确认侧边栏导航
   • 测试所有文档页面
   • 确认教程页面正常

常见问题

注意

避免这些常见错误：

1. 忘记同步: 总是运行 bunx cap sync 在示例中
2. 命名不一致: 在所有地方使用相同的插件名称
3. 缺少平台配置: 文档 iOS 和 Android 的设置
4. 断裂的链接: 使用相对链接并验证它们可用
5. 缺少错误处理: 总是在示例中显示 try-catch
6. 缺少导入: 必须在示例中包含所有必要的导入
7. 不清晰的描述: 描述插件的具体功能

获取帮助

如果您需要帮助添加或更新插件文档:

• Discord: 加入我们的 Discord 社区
• GitHub: 在网站仓库中打开一个问题 Discord 社区
• 邮箱: 联系团队 support@capgo.app

示例

参考以下文档齐全的插件：

• 更新器: /src/content/docs/docs/plugins/updater/ (复杂插件，多页)
• 闪存: /src/content/docs/docs/plugins/flash/ (简单插件，好用的示例)
• 社交登录: /src/content/docs/docs/plugins/social-login/ (插件有子页)

概要

将Capgo文档中的插件添加到其中涉及:

1. 添加元数据到主配置
2. 将插件添加到分类索引页面
3. 配置侧边栏导航
4. 创建全面且详细的文档页面
5. 编写详细的教程
6. 在本地测试所有更改

按照本指南，您可以确保插件的文档一致且易于用户发现。

继续阅读添加或更新插件

如果您正在使用 添加或更新插件 用于规划原生插件工作的 Capgo 插件目录 Capgo 插件目录中的产品工作流程 Capacitor Plugins by Capgo for the implementation detail in Capacitor Plugins by Capgo, Ionic 企业插件替代品 __CAPGO_KEEP_0__ 原生构建 Capgo 原生构建中的产品工作流程 Capgo 插件：您需要知道的 Capacitor Native Builds {"targetLanguage":"Simplified Chinese","pagePath":"/zh/docs/contributing/adding-plugins/","protectedTokens":["Cloudflare","Capacitor","GitHub","Capgo","code","API","SDK","CLI","npm","bun"],"items":[{"text":"为Capacitor插件的实际应用场景准备: 什么你需要知道。"},{"text":"编辑页面"}]}