sourcey/sourcey

해결하는 문제

Sourcey는 API 사양, 소스 코드 주석, 마크다운 가이드와 같은 다양한 형식의 기술 문서가 분산되어 있는 문제를 해결합니다. OpenAPI, MCP, Doxygen XML, godoc, rustdoc, Markdown 등의 다양한 입력을 하나의 통합된 정적 HTML 웹사이트로 통합합니다. C++용 Breathe/Exhale/Sphinx 체인과 같은 복잡한 파이프라인을 필요로 하지 않으며, pkg.go.dev과 같은 언어별 문서를 외부 호스팅에 의존할 필요도 없습니다.

작동 방식

빌드 시 생성기로서 OpenAPI, MCP, Doxygen XML, godoc, rustdoc, Markdown 등의 다양한 입력을 분석하여 정적 HTML로 렌더링합니다. 사이트 구조와 탐색을 정의하는 TypeScript 기반 구성 파일(sourcey.config.ts)을 사용합니다. CLI로 실행하거나, Astro 사이트에 통합하거나, 개발 중 핫리로드를 위해 Vite 개발 서버와 함께 사용할 수 있습니다.

대상 사용자

다중 언어 코드베이스나 복잡한 API 사양을 가진 소프트웨어 프로젝트의 포괄적인 문서를 유지 관리해야 하는 개발자 및 기술 작가를 위한 도구입니다. 런타임 종속성을 갖지 않고 정적 출력물을 직접 소유하고 싶어하는 사용자에게 적합합니다.

주요 기능

• 다중 소스 지원: OpenAPI(2.0~3.2), MCP 서버 문서, Doxygen(C++), godoc(Go), rustdoc(Rust) 통합.
• LLM 대응: AI 모델용 포터블 컨텍스트를 제공하기 위해 자동으로 llms.txt 및 llms-full.txt 파일을 생성.
• 풍부한 마크다운: 표준 마크다운 파일 내에서 스텝, 카드, 액코디언과 같은 사용자 정의 컴포넌트 지원.
• 정적 출력: 프레임워크 없이 HTML을 생성하여 GitHub Pages, Vercel, S3 등 어떤 정적 호스팅에도 배포 가능.
• 유연한 테마: 기본, 미니멀, API 우선, 리더 등 여러 레이아웃 옵션과 사용자 정의 가능한 색상 및 폰트 제공.