JSDoc 주석으로부터 TypeScript API 문서를 자동 생성하는 도구
중간맛 분석
스택: TypeScript, JSDoc, 플러그인 시스템. 난이도: 낮음 (기존 JSDoc 주석만으로도 동작). 바로 쓸 수 있음: 예 (단 docflow build 명령어로 필요하나 에 상세 설명 부재). @public, @category, @example 태그 지원, AI와 함께 JSDoc 자동 생성(@generate 태그), TypeScript 타입 정보를 정확히 추출하여 문서화. VitePress, Docusaurus, Nextra 등 주요 문서 생성 도구에 대한 플러그인 제공.
이런 레포예요
이럴 때 쓰면 좋아요
- TypeScript 라이브러리 개발 시 JSDoc 주석을 API 문서 페이지로 즉시 변환
- 대규모 팀 프로젝트에서 JSDoc을 소스 오브 트루스로 삼아 문서 동기화 자동화
- AI와 결합하여 기존 코드의 JSDoc 주석을 자동 생성 및 보강
핵심 기능
대안 대비 차별점
AI 기반 JSDoc 자동 생성과 정확한 TypeScript 타입 동기화로, 개발자 부담을 줄이면서도 항상 최신의 문서를 유지할 수 있습니다.
먹어본 사람들
실제로 차려 먹어본 손님들의 흔적이에요 — 한마디와 완주 인증 모두 검수 후 공개돼요.
이 레포, 해먹는 법
처음 오셨어요? 어렵지 않아요 — 위에서 아래로 따라 하면 내 컴퓨터에 이 레포를 차려서 바로 맛볼 수 있어요.
준비물
- Node.js
- TypeScript
바로 차려먹기Node.js (yarn)
깃밥이 레포 구조를 확인하고 만든 실행 명령이에요. 터미널에 붙여넣으면 받기부터 실행까지 한 번에 진행돼요.
git clone --depth 1 https://github.com/toss/docflow.git && cd docflow && yarn
실행 명령은 README를 확인하세요.
코드는 내 컴퓨터에서 실행돼요 — 처음 보는 레포라면 내용을 한번 훑어보고 실행하는 습관을 추천해요.
깃밥트라이로 맛보기
받아보기 귀찮고 살짝 불안했다면 — 안전 스캔부터 설치까지 터미널 한 줄로 끝나요.
터미널에 붙여넣으면 깃밥 안전 스캔 → 격리 폴더 clone → 설치 → 실행법 안내까지 자동이에요. 처음이어도 괜찮아요 — 이 한 줄이 전부예요.
npx gitbap-try toss/docflow
Node.js만 있으면 설치 없이 실행돼요 · 깃밥트라이가 뭐예요? →
별 추이 · 7일
활용성 · 따라 만들기 좋은가
- 관대한 라이선스
- 테스트 있음
- 예제 디렉토리
- 최근 활동
- AGENTS.md
- llms.txt
- 템플릿
⚪ 최근 활동 정보 없음 · 2025년 생성
「웹·Next.js·풀스택」 이런 레포, 매주 받아보실래요?
매주 월요일 아침, 골라 담은 밥상만. 광고 없이 · 언제든 해지.
내 레포인가요? README에 깃밥 배지 달기
[](https://www.gitbap.com/r/toss/docflow)🔌 클로드에서 바로 써보기 — 깃밥 연결하는 법
깃밥을 클로드에 연결하면 이런 레포를 클로드·커서·Codex에서 바로 찾고 체험할 수 있어요.
클로드 설정 → 커넥터에 이 주소를 붙여넣기.
https://www.gitbap.com/api/mcp플러그인을 설치하면 /gitbap-trending·/gitbap-try 슬래시 커맨드로 레포를 그 자리에서 체험. Claude Code에서 아래 두 줄을 차례로 실행하세요.
/plugin marketplace add jakeparkcolde/gitbap-cowork/plugin install gitbap-cowork@gitbapAI가 README 기반으로 요약했습니다 · 원문 보기