Back to Skills

markdown-pro

verified

세련된 README 파일, 변경 이력(changelog), 기여 가이드(contribution guide) 및 기술 문서를 작성하기 위한 전문가 수준의 Markdown 문서화 SKILL입니다. 사용 사례: (1) 배지와 섹션을 포함한 README 생성, (2) git 히스토리를 이용한 자동 변경 이력 생성, (3) 목차(table of contents) 생성, (4) 기여 가이드라인 작성, (5) 기술 문서 포맷팅, (6) 구문 강조(syntax highlighting)를 포함한 코드 문서화

View on GitHub

Marketplace

icartsh-marketplace

icartsh/icartsh_plugin

Plugin

icartsh-plugin

Repository

icartsh/icartsh_plugin
1stars

icartsh-plugin/skills/markdown-pro/SKILL.md

Last Verified

January 20, 2026

Install Skill

Select agents to install to:

Scope:
npx add-skill https://github.com/icartsh/icartsh_plugin/blob/main/icartsh-plugin/skills/markdown-pro/SKILL.md -a claude-code --skill markdown-pro

Installation paths:

Claude
.claude/skills/markdown-pro/
Powered by add-skill CLI

Instructions

# Professional Markdown Documentation

## 개요 (Overview)

이 SKILL은 전문적이고 잘 구조화된 Markdown 문서를 작성하기 위한 포괄적인 가이드를 제공합니다. 최신 포맷팅, 배지 및 모범 사례를 적용한 README 파일, 변경 이력, 기여 가이드 및 기술 문서를 다룹니다.

## 핵심 역량 (Core Capabilities)

### README 생성
- 프로젝트 개요 및 설명
- 설치 지침
- 코드 블록을 포함한 사용 예시
- API 문서화
- 배지(badges) 및 실드(shields)
- 주요 특징 강조
- 스크린샷 및 데모

### 변경 이력(Changelog) 자동화
- 시맨틱 버저닝(Semantic versioning) 형식
- Git 히스토리 파싱
- 자동 릴리스 노트 생성
- 주요 변경 사항(Breaking changes) 강조
- 기여자 표시 (attribution)

### 기술 문서화
- 명확한 섹션 계층 구조
- 코드 구문 강조 (Syntax highlighting)
- API 참조 포맷팅
- 목차 (Table of contents)
- 상호 참조 (Cross-referencing)
- 접기/펼치기 섹션 (Collapsible sections)

## README 구조 모범 사례

### 필수 섹션

**1. 배지를 포함한 헤더**
```markdown
# 프로젝트 이름

[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
[![Version](https://img.shields.io/badge/version-1.0.0-green.svg)](releases)
[![Build](https://img.shields.io/badge/build-passing-brightgreen.svg)](builds)

프로젝트가 무엇인지 설명하는 짧은 한 줄 설명.
```

**2. 목차 (Table of Contents)** (내용이 긴 README의 경우)
```markdown
## 목차

- [주요 특징](#features)
- [설치 방법](#installation)
- [사용법](#usage)
- [API 참조](#api-reference)
- [기여하기](#contributing)
- [라이선스](#license)
```

**3. 주요 특징 섹션 (Features)**
```markdown
## 주요 특징

- **특징 1**: 장점과 함께 명확한 설명 제공
- **특징 2**: 어떤 문제를 해결하는지 기술
- **특징 3**: 독특한 강점 강조
- 크로스 플랫폼 지원 (Windows, macOS, Linux)
- 포괄적인 테스트 커버리지 (>90%)
```

**4. 설치 방법 (Installation)**
```markdown
## 설치 방법

### 사전 요구 사항
- Python 3.8 이상
- pip 패키지 매니저

### 빠른 시작

```bash
pip install package-name
```

### 소스에서 설치

```bash
git clone https://github.com/username/repo.git
cd repo
pip install -e .
```
```

**5. 사용 예시 (Usage)**
```markdown
## 사용법

### 기본 예시

```python
from package import Module

# 초기화
client = Module(api_key="your-key")

# 작업 수행
result = client.process(data)
print(result)
```

### 고급 사용법

더 자세한 사용 사례는 [examples/](examples/) 디렉토리를 참조하세요.
```

**6. API 문서화 (API Reference)**
```markdown
## API 참조

### `Module.process(data, options=None)`

선택적 설정을 사용하여 입력 데이터를 처리합니다.

**매개변수:*

Validation Details

Front Matter
Required Fields
Valid Name Format
Valid Description
Has Sections
Allowed Tools
Instruction Length:
7366 chars