sourcey/sourcey

해결하는 문제

Sourcey는 API 사양, 소스 코드 주석, 마크다운 가이드와 같은 다양한 형식의 기술 문서가 분산되어 있는 문제를 해결하여 하나의 통합된 정적 HTML 웹사이트로 통합합니다. C++용 Breathe/Exhale/Sphinx 파이프라인과 같은 복잡한 도구 체인을 사용하거나 API 참조를 위해 외부 호스팅 서비스에 의존할 필요가 없습니다.

작동 방식

빌드 시 다양한 문서 소스를 파싱하여 포터블한 HTML 사이트로 렌더링하는 정적 사이트 생성기로 작동합니다. sourcey.config.ts 설정 파일을 통해 다음과 같은 다양한 입력 형식을 지원합니다:

• API 사양: OpenAPI (2.0 ~ 3.2) 및 MCP 서버 문서.
• 소스 코드: Doxygen XML (C++), 네이티브 Go 도구 체인 추출 (godoc), 야간 빌드 rustdoc JSON (Rust).
• 가이드: 마크다운 파일 및 기존 MkDocs 구조.

Vite 기반 개발 서버를 제공하여 핫 리로딩을 지원하며, Astro 사이트에 직접 통합하거나 어떤 호스팅에도 정적 파일로 배포할 수 있습니다.

대상 사용자

복잡한 API나 다중 언어 코드베이스를 가진 소프트웨어 프로젝트에 대해 검색 가능한 전문적인 문서를 유지 관리해야 하는 개발자 및 기술 작가를 위한 도구입니다.

주요 특징

• 통합 빌드: 하나의 빌드 프로세스로 API 참조, 가이드, 변경 내역, 로드맵을 생성.
• LLM 대응: AI 모델용 포터블 컨텍스트를 제공하기 위해 자동으로 llms.txt 및 llms-full.txt 파일 생성.
• 다양한 언어 지원: Go와 Rust 문서에 대한 네이티브 지원, C++는 Doxygen을 통해 지원.
• 풍부한 마크다운: 스텝, 카드, 액코디언 등의 내장 컴포넌트로 가이드를 강화.
• 런타임 없음: 렌더링에 대시보드나 API 호출이 전혀 필요 없이 정적 HTML만 생성.