Keep going from Adding or Updating Plugins

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

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

개요

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/"
/>
```
__CAPGO_KEEP_0__:
- ⭐ 주요 플러그인
- 📱 기기 및 시스템 플러그인
- 🎥 미디어 및 카메라 플러그인
- 🛠️ 유틸리티 플러그인
- 🤖 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 Concise
정확하게 말하라: 플러그인이 무엇을 하는지 설명하라, 무엇인지 설명하지 마라
동사 사용하라: “제어”, “통합”, “활성화”와 같은 동사로 시작하라

좋은 예시:

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

나쁜 예시:

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

문서 작성을 위한 기여

설치 시작: 명확한 설치 단계부터 시작하세요
설정 제공: 플랫폼에 따라 요구되는 설정 요구 사항을 포함하세요
사용 예제 보여주기: 실제 code 예제를 제공하세요
API 참조 포함: 모든 메서드와 매개 변수를 문서화하세요
완전한 예제 추가: 실제-world 사용 패턴을 보여주세요
List Best Practices: 사용하기 좋은 방법을 공유하세요
Document Platform Differences: iOS와 Android의 차이점을 설명하세요
Add Troubleshooting: 일반적인 문제를 해결하세요

Code Examples

Use TypeScript for all code examples
모든 __CAPGO_KEEP_0__ 예시에서 TypeScript를 사용하세요
Include imports at the top
위치에 import문을 포함하세요 (위치: 위쪽, 아래쪽, 중간 등은 중요하지 않습니다.)
기본 및 고급 사용법을 모두 보여주세요

체크리스트

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

아이콘 참조

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

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

기존 플러그인 업데이트

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

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

언어 경로

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

변경을 테스트하세요

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

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

일반적인 함정

도움말 받기

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

디스코드: 우리의 디스코드 커뮤니티에 가입하십시오
GitHub: __CAPGO_KEEP_0__에 이슈를 열으십시오 웹사이트 저장소
이메일: Capgo 마케팅 웹사이트에 있는 등록 페이지에서 보이는 UI 레이블입니다. 메시지 키 `email_label` (이메일 레이블). | 라이브 업데이트 제품 페이지에서 보이는 UI 레이블입니다. 메시지 키 `live_update_guidance_email_label` (라이브 업데이트 안내 이메일 레이블). support@capgo.app

support@__CAPGO_KEEP_0__.app

예시

참고로, 다음 잘 문서화된 플러그인을 확인하세요:: /src/content/docs/docs/plugins/updater/ 업데이터
(복잡한 플러그인, 여러 페이지): /src/content/docs/docs/plugins/flash/ 플래시
(단순한 플러그인, 좋은 시작 예시입니다.): /src/content/docs/docs/plugins/social-login/ (__CAPGO_KEEP_0__ 플러그인과 하위 페이지)

개요

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

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

이 가이드를 따르면 사용자가 플러그인을 쉽게 발견하고 문서화할 수 있도록 합니다.

Adding or Updating Plugins로 계속 진행하세요

만약 당신이 Adding or Updating Plugins 을 사용 중이라면 Capgo 플러그인 디렉토리 를 Capgo 플러그인 디렉토리에서 제품 워크플로우와 연결하세요. Capacitor 플러그인들에 의해 Capgo 를 Capacitor 플러그인들에 의해 Capgo에서 구현 세부 정보를 위해 Ionic Enterprise Plugin Alternatives 를 Ionic Enterprise Plugin Alternatives에서 제품 워크플로우와 연결하세요. Capgo 네이티브 빌드 를 Capgo 네이티브 빌드에서 제품 워크플로우와 연결하세요. Capacitor 플러그인: 알아야 할 사항 실용적인 Capacitor 플러그인: 알아야 할 사항의 맥락에서

Keep going from Adding or Updating Plugins

개요

파일 위치

중요 파일 업데이트

단계별 가이드

마스터 목록에 플러그인 추가

제목이 "인덱스 페이지에 플러그인 추가"인 섹션

사이드바 네비게이션에 추가

플러그인 문서 디렉토리 만들기

플러그인 개요 페이지 만들기

시작 가이드 작성

튜토리얼 파일 생성

플러그인 문서 구조

필수 파일

선택적 파일

콘텐츠 지침

콘텐츠 지침

문서 작성을 위한 기여

Code Examples

체크리스트

아이콘 참조

기존 플러그인 업데이트

언어 경로

변경을 테스트하세요

일반적인 함정

도움말 받기

support@__CAPGO_KEEP_0__.app

개요

Adding or Updating Plugins로 계속 진행하세요