__CAPGO_KEEP_1__

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.

설치, 동기화 및 소스 마크다운 가이드를 포함합니다.

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. Master List에 플러그인을 추가하세요

   열기 /src/config/plugins.ts 플러그인을 Master List에 추가하세요. 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/ Index Page에 플러그인을 추가하세요

2. Step-by-Step Guide를 위한 단계별 안내: Index Page에 플러그인을 추가하는 방법

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

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를 사용하여 안전한 인증을 활성화하세요”

Bad Examples:

• 플러그인 예시
• '플래시 플러그인'
• '이것은 Crisp 플러그인입니다'

'생체 인식 플러그인'

1. 설치 시작'설치 방법을 명확하게 설명하세요'
2. 설정 제공'플랫폼에 따라 설정을 제공하세요'
3. 사용 예시 제공'작동하는 code 예시를 제공하세요'
4. Include API Reference: 문서화된 모든 메서드 및 매개 변수
5. 완전한 예제 추가: 실제 세계 사용 패턴을 보여줍니다
6. 최적의 사용을 위한 팁 공유플랫폼 차이 문서화
7. : iOS vs Android 동작을 명확히 합니다문제 해결
8. : 일반적인 문제를 해결합니다__CAPGO_KEEP_0__ 예제

제목이 "Code 예제"인 섹션

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

체크리스트

새 플러그인을 추가할 때 사용하는 체크리스트입니다:

• 플러그인을 추가했습니다 /src/config/plugins.ts
• Heroicons에서 적절한 아이콘을 선택했습니다
• 플러그인을 추가했습니다 /src/content/docs/docs/plugins/index.mdx 적절한 카테고리 아래에
• Added sidebar entry in /astro.config.mjs
• Created plugin 문서화 디렉토리
• Created index.mdx 개요 페이지
• Created getting-started.mdx 가이드
• Created tutorial in /src/content/plugins-tutorials/en/
• 설치 방법을 포함했습니다
• iOS 설정을 문서화했습니다
• Android 설정을 문서화했습니다
• 사용 예를 제공했습니다
• API 참조를 추가했습니다
• 포함된 완전한 작동 예제
• 리스트된 최적의 관행
• 추가된 플랫폼별 주의사항
• 테스트된 모든 링크가 올바르게 작동합니다.

아이콘 참조

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

아이콘	사용 사례
BoltIcon	闪烁, 전원, 에너지
CameraIcon	카메라, 사진, 비디오
ChatBubbleLeftIcon	채팅, 메시징, 통신
FingerPrintIcon	__CAPGO_KEEP_0__
MapPinIcon	__CAPGO_KEEP_0__
SpeakerWaveIcon	__CAPGO_KEEP_0__
VideoCameraIcon	__CAPGO_KEEP_0__
CreditCardIcon	__CAPGO_KEEP_0__
PlayCircleIcon	__CAPGO_KEEP_0__
SignalIcon	__CAPGO_KEEP_0__
RadioIcon	__CAPGO_KEEP_0__
ChatBubbleOvalLeftIcon	__CAPGO_KEEP_0__

__CAPGO_KEEP_0__

__CAPGO_KEEP_0__

1. 버전 번호를 업데이트 하세요 문서에 반영하세요
2. 이동 가이드를 추가하세요 파괴적인 변경이 존재할 경우
3. API 참조를 업데이트 하세요 새로운 메소드와 함께
4. 새로운 기능에 대한 예제를 추가하세요 새로운 기능에 대한
5. 플랫폼 요구 사항을 업데이트 하세요 변경된 경우
6. 최선의 방법을 재고하세요 새로운 기능에 따라
7. 최신 __CAPGO_KEEP_0__를 유지하세요 최신 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. 필요한 import가 누락되었습니다.: 플러그인의 기능에 대해 자세히 설명하세요.
7. 도움말 받기‘도움말 받기’라는 제목의 섹션

플러그인 문서 추가 또는 업데이트 도움을 받으실 경우:

__CAPGO_KEEP_0__

• __CAPGO_KEEP_0__: __CAPGO_KEEP_0__에 참여하세요 디스코드 커뮤니티
• GitHub: __CAPGO_KEEP_0__ 웹사이트 리포지토리에 이슈를 열어보세요 웹사이트 리포지토리
• 이메일: __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/ 플러그인(서브 페이지)

요약

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

1. 마스터 구성 파일에 메타데이터를 추가하는 것
2. 분류된 인덱스 페이지에 플러그인을 추가하는 것
3. 사이드바 내비게이션을 구성하는 것
4. 전반적인 문서 페이지를 만드는 것
5. Capgo 문서를 자세히 작성하는 방법
6. 모든 변경 사항을 로컬에서 테스트하는 방법

이 안내서를 따라하면 플러그인은 일관되게 문서화되고 사용자가 쉽게 찾을 수 있습니다.

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

이 가이드를 사용하는 경우 __CAPGO_KEEP_0__ 플러그인 추가 또는 업데이트 __CAPGO_KEEP_0__ 플러그인 디렉토리와 연결하여 Capgo 플러그인 디렉토리에서 제품 워크플로우를 위해 Capgo 플러그인 Capacitor Plugins by Capgo for the implementation detail in Capacitor Plugins by Capgo, Ionic Enterprise Plugin Alternatives Ionic Enterprise Plugin Alternatives 제품 워크플로우를 위한 Capgo Native Builds Capgo Native Builds 제품 워크플로우를 위한 Capacitor Plugins: What You Need to Know Capacitor Plugins: What You Need to Know에 대한 실용적인 맥락을 위한