플러그인을 추가하거나 업데이트 하세요

이 플러그인의 설치 단계와 전체 마크다운 가이드를 포함한 설정 프롬프트를 복사하세요.

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

개요

Capgo 생태계에 새로운 플러그인을 추가할 때는 여러 파일과 위치를 업데이트해야 하며, 플러그인이 모든 관련된 장소에서 올바르게 표시되도록 해야 합니다:

플러그인 목록 구성 - 마스터 목록에 플러그인 메타데이터를 추가합니다.
플러그인 인덱스 페이지 - 카테고리별 플러그인 목록 페이지에 플러그인을 추가합니다.
사이드바 네비게이션 - __CAPGO_KEEP_0__ 플러그인을 문서 사이드바에 추가하세요
플러그인 문서 - 개요 및 시작 가이드 페이지를 생성하세요
플러그인 튜토리얼 - 포괄적인 튜토리얼을 생성하세요

파일 위치

업데이트해야 하는 주요 파일

파일	목적
`/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/"
/>
```
📱 장치 및 시스템 플러그인:
- 🎥 미디어 및 카메라 플러그인
- 📋 카테고리']} // Removed the extra string from the original array. The extra string was not in the original array. It was added by mistake. The correct array should have 12 strings. The extra string was
- Open
- 🛠️ 유틸리티 플러그인
- 🤖 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

선택적 파일

Plugin에 대한 추가 문서 페이지를 만들 수 있습니다.

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자 이내로 작성하세요
정확하게 쓰세요플러그인이 무엇을 하는지 설명하세요, 아니라 플러그인이 무엇인지 설명하지 마세요
행동 단어를 사용하세요: __CAPGO_KEEP_0__과 같은 동사로 시작하세요. 예를 들어 “Control”, “Integrate”, “Enable”를 사용하세요.

좋은 예시:

“단순한 켜고 끄기 스위치로 장치의 플래시 라이트와 토치를 제어하세요.”
“앱에 라이브 채팅과 고객 지원을 통합하세요.”
“Face ID와 Touch ID를 사용하여 안전한 인증을 활성화하세요.”

나쁜 예시:

“플래시용 플러그인”
“이것은 Crisp 플러그인입니다.”
“생체 인증 플러그인”

문서 작성을 위한 설명서

설치부터 시작하세요: 설치를 시작하기 전에 명확한 설치 단계를 따라야 합니다.
설정 제공: 플랫폼에 따라 특정한 설정 요구 사항을 포함해야 합니다.
사용 예제 보여주기: 실제로 작동하는 code 예제를 제공해야 합니다.
API 참고 자료 포함: 모든 메서드와 매개 변수를 문서화해야 합니다.
완전한 예제 추가: 실제 세계에서 사용하는 패턴을 보여주어야 합니다.
최적의 사용 방법에 대한 팁 공유: 플랫폼 간의 차이점을 문서화해야 합니다.
설정 제공: iOS와 Android의 동작을 명확히 하세요.
문제 해결을 추가하세요.: 일반적인 문제를 해결하세요.

Code 예시

모든 code 예시에서 TypeScript를 사용하세요.
위에 import를 포함하세요.
중요한 단계를 설명하는 주석을 추가하세요.
에러 처리를 보여주세요.
기본적인 사용법과 고급 사용법을 모두 보여주세요.

체크리스트

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

아이콘 참조

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

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

기존 플러그인 업데이트

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

버전 번호 업데이트 문서에
이동 가이드 추가 파괴적인 변경 사항이 있는 경우
API 참조 업데이트 새로운 메서드와
새로운 예시 추가 새로운 기능을 위한 기능
플랫폼 요구 사항 업데이트 변경 시
새로운 기능에 따라 최적화 새로운 기능에 따라 최적화
최신 __CAPGO_KEEP_0__와 함께 튜토리얼을 유지 with latest API

‘언어 경로’라는 제목을 가진 섹션

변경을 테스트하는 방법

‘변경을 테스트하는 방법’이라는 제목을 가진 섹션

__CAPGO_KEEP_0__ 추가 또는 업데이트 후 플러그인 문서를 확인하세요:

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

일반적인 오류

이러한 일반적인 오류를 피하세요:

sync를忘지 않도록 하세요: 항상 실행하세요 bunx cap sync 예시에서 사용하는 것과 일치하는 이름을 사용하십시오.
이름이 일관되지 않습니다.: 모든 예시에서 동일한 플러그인 이름을 사용하십시오.
플랫폼 설정이 누락되었습니다.: iOS와 Android의 설정 모두 문서화하십시오.
링크가 깨졌습니다.: 상대적 링크를 사용하고 작동하는지 확인하십시오.
에러 처리가 누락되었습니다.: 모든 예시에서 try-catch를 항상 표시하십시오.
필요한 임포트가 누락되었습니다.: 모든 필요한 임포트를 예시에서 포함하십시오.
설명이 불분명합니다.: 플러그인 기능에 대한 자세한 설명을 제공하세요.

도움말

플러그인 문서 추가 또는 업데이트 도움을 필요로 하는 경우:

다음과 같은 방법으로 도움을 받으실 수 있습니다.다음과 같은 방법으로 도움을 받으실 수 있습니다. __CAPGO_KEEP_0__
GitHub사이트 저장소 이메일
: 팀에 연락하세요.다음과 같은 방법으로 도움을 받으실 수 있습니다. capgo.app에 대한 지원

예시

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

업데이터: /src/content/docs/docs/plugins/updater/ (복잡한 플러그인, 여러 페이지가 있습니다.)
플래시: /src/content/docs/docs/plugins/flash/ (단순한 플러그인, 좋은 시작 예시입니다.)
소셜 로그인: /src/content/docs/docs/plugins/social-login/ (서브 페이지가 있는 플러그인.)

요약

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

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

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