플러그인 추가 또는 업데이트

설치 단계와 이 플러그인에 대한 전체 마크다운 가이드를 포함하여 플러그인 설정 프롬프트 복사하기

Capacitor 플러그인을 Capgo 웹사이트에 추가하거나 기존 플러그인 문서를 업데이트하는 방법을 설명하는 이 가이드는 기여자, 유지관리자 및 문서 유지 관리를 도와주는 AI agent에게 유용합니다.

개요

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__ 영어 튜토리얼 파일

__CAPGO_KEEP_0__ 단계별 설명서

__CAPGO_KEEP_1__ 플러그인 추가

protectedTokens /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 및 고급 미디어
- 📍 위치 및 백그라운드 서비스
- 📞 통신 및 분석
- 🔐 보안 및 시스템
- 📊 안드로이드 전용 기능
- 📥 다운로드 및 네비게이션
사이드바 네비게이션에 추가
‘사이드바 네비게이션에 추가’ 제목

열기 /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자 이하로 유지하세요
Be Specific: 플러그인의 기능을 설명하십시오, 그 플러그인이 무엇인지 설명하지 마십시오
Use Action Words: "제어", "통합", "활성화"와 같은 동사로 시작하십시오

Good Examples:

“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

모든 code 예제에 TypeScript 사용
위에 import 문 포함
중요한 단계에 대한 주석 추가
에러 처리를 보여줍니다
기본 및 고급 사용법을 모두 보여주세요

체크리스트

새 플러그인을 추가할 때 이 체크리스트를 사용하세요:

아이콘 참조

플러그인에 사용되는 일반 아이콘 ( astro-heroicons/mini/):

아이콘	사용 사례
`BoltIcon`	闇光, 전원, 에너지
`CameraIcon`	카메라, 사진, 비디오
`ChatBubbleLeftIcon`	채팅, 메시징, 통신
`FingerPrintIcon`	생체 인식, 보안, 인증
`MapPinIcon`	위치, 위치 정보, 지도
`SpeakerWaveIcon`	음성, 소리, 음악
`VideoCameraIcon`	비디오, 녹음, 스트리밍
`CreditCardIcon`	결제, 구매
`PlayCircleIcon`	미디어 플레이어, 비디오 플레이어
`SignalIcon`	연결성, 네트워크, 비콘
`RadioIcon`	비콘, 방송, 무선
`ChatBubbleOvalLeftIcon`	소셜 미디어, WeChat

기존 플러그인 업데이트

기존 플러그인을 업데이트할 때:

버전 번호 업데이트 문서에
이동 가이드 추가 파괴적인 변경이 존재할 경우
업데이트 API 참조 __CAPGO_KEEP_0__의 새로운 메서드와 함께
새로운 기능에 대한 새로운 예제 추가 새로운 기능에 대한 새로운 예제
플랫폼 요구 사항 업데이트 변경된 경우
새로운 기능에 따라서 최적화된 방법 새로운 기능에 따라서 최적화된 방법
튜토리얼을 최신 __CAPGO_KEEP_0__로 유지 API의 최신 버전

언어 경로

영어로 플러그인 문서를 작성하고 검토하세요. 지역화된 경로는 사이트 메타데이터에 의해 생성되고 Edge에서 번역 Worker로 번역됩니다.

변경 사항 테스트

플러그인 문서를 추가하거나 업데이트 한 후:

사이트를 로컬에서 빌드하세요:
터미널 창
```
bun run build
```
오류 확인:
- 모든 링크가 작동하는지 확인
- 이미지가 올바르게 로드되는지 확인
- code 예제가 유효한지 확인
- 네비게이션이 작동하는지 테스트
사이트 미리보기:
터미널 창
```
bun run dev
```
플러그인 목록에 표시되는지 확인:
- 플러그인 목록 페이지 확인
- 사이드바 네비게이션 확인
- 모든 문서 페이지 테스트
- 튜토리얼 페이지가 작동하는지 확인

일반적인 오류

도움말 받기

플러그인 문서 추가 또는 업데이트에 도움이 필요하시면:

디스코드: 우리의 디스코드 커뮤니티에 가입하십시오
: GitHub: 플러그인 문서에 대한 이슈를 열으십시오 웹사이트 저장소
이메일: 팀에 연락하세요 support@capgo.app

예시

참고로, 이 잘 문서화된 플러그인들을 확인하세요:

업데이터: /src/content/docs/docs/plugins/updater/ (복잡한 플러그인, 여러 페이지)
플래시: /src/content/docs/docs/plugins/flash/ (단순한 플러그인, 좋은 시작 예시)
소셜 로그인: /src/content/docs/docs/plugins/social-login/ (플러그인과 하위 페이지)

개요

Capgo 문서에 플러그인을 추가하는 것은 다음과 같습니다:

마스터 구성 파일에 메타데이터를 추가하는 것
분류된 인덱스 페이지에 플러그인을 추가하는 것
사이드바 네비게이션을 구성하는 것
전반적인 문서 페이지를 만들기
상세한 튜토리얼을 작성하는 것
모든 변경 사항을 로컬에서 테스트하는 것

이 가이드를 따르면 사용자가 플러그인을 쉽게 찾을 수 있고 일관된 문서로 문서화할 수 있습니다.