pradeepmouli/to-skills

to-skills은(는) 무엇을 하나요?

TypeScript API 문서에서 AI 에이전트 스킬(SKILL.md)을 생성합니다 — TypeDoc 플러그인 + CLI + Docusaurus/VitePress

개요

to-skills는 TypeScript 프로젝트의 API 문서에서 AI 에이전트(Claude Code, Cursor, Codex 등)가 이해할 수 있는 SKILL.md 파일을 자동 생성하는 도구입니다.

특징

• TypeDoc 플러그인: 기존 TypeDoc 문서 생성 과정에 통합
• CLI 도구: 독립 실행형 명령줄 도구
• Docusaurus/VitePress 통합: 문서 사이트와 함께 사용 가능
• 자동 업데이트: 문서 변경 시 SKILL.md 자동 갱신

설치

npm install to-skills

또는

yarn add to-skills

사용법

TypeDoc 플러그인으로 사용

typedoc.json에 플러그인 추가:

{
  "plugin": ["to-skills/plugin"]
}

CLI로 사용

npx to-skills --out ./path/to/SKILL.md

Docusaurus / VitePress와 통합

Docusaurus 설정 예시:

module.exports = {
  plugins: [
    ['to-skills/docusaurus', {
      output: './static/SKILL.md'
    }]
  ]
};

SKILL.md 출력 예시

생성된 SKILL.md 파일은 다음과 같은 구조를 갖습니다:

• 프로젝트 개요
• 주요 모듈 및 API 목록
• 함수, 클래스, 인터페이스에 대한 설명
• 사용 예제 (코드 스니펫)

라이선스

MIT