tomehq/tome

해결하는 문제

Tome은 Markdown 및 MDX 파일에서 아름답고 전문적인 문서 사이트를 빠르게 생성할 수 있는 오픈소스 문서 플랫폼입니다. Mintlify나 GitBook과 같은 관리형 문서 서비스의 비용 효율적이고 자체 호스팅 가능한 대안을 제공하며, 벤더 종속성을 제거하면서도 API 참조 생성 및 통합 검색과 같은 고급 기능을 제공합니다.

작동 방식

개발자는 Markdown 또는 MDX(React 컴포넌트를 포함한 Markdown)로 문서를 작성합니다. Tome은 이 콘텐츠를 정적 사이트로 변환합니다. CLI를 사용하여 프로젝트 세팅, 개발, 빌드가 가능합니다. 사용자는 Vercel, Netlify, S3와 같은 플랫폼에 정적 출력물을 자체 호스팅하거나, Tome Cloud를 사용해 관리형 호스팅을 선택할 수 있습니다.

대상 사용자

버전 관리와 OpenAPI 사양에서 생성된 API 참조를 지원하는, 설치가 간편한 전문적인 문서 사이트가 필요한 소프트웨어 개발자 및 기술 작가.

주요 특징

• AI 통합: BYOK을 포함한 내장 AI 어시스턴트와 AI 도구용 기계 가독성 출력을 위한 MCP 서버 제공.
• API 참조 생성: OpenAPI 사양에서 인터랙티브한 API 참조 페이지를 자동 생성.
• 콘텐츠 소스: GitHub 리포지토리, Notion 데이터베이스, 또는 사용자 정의 API에서 문서 콘텐츠를 가져올 수 있음.
• 개발자 경험: 내장된 콘텐츠 린트, 손상된 링크 검사, GitBook 또는 Mintlify에서 한 번의 명령으로 마이그레이션 가능.
• 사용자 맞춤 설정: 완전한 CSS 제어, 여러 내장 테마 프리셋, 사용자 정의 빌드 훅을 위한 플러그인 시스템.