livesession/xyd

어떤 프로젝트인가요?

핵심 기능

• 01Markdown 및 MDX 콘텐츠에서 문서를 생성합니다
• 02OpenAPI 및 GraphQL 사양을 바탕으로 API 레퍼런스 페이지를 만듭니다
• 03API 사양을 바탕으로 SDK를 생성할 수 있습니다
• 04기본 테마와 전문 검색을 제공합니다
• 05분석, A/B 테스트, 라이브 채팅 연동을 제공합니다
• 06컴포넌트와 레이아웃을 사용자 지정할 수 있습니다

활용 사례

• 웹 애플리케이션의 제품 문서를 게시할 때
• 생성된 레퍼런스 페이지로 REST 또는 GraphQL API를 문서화할 때
• API 문서와 함께 SDK를 제공하는 개발자 포털을 구축할 때
• 기존 문서 사이트를 다른 프레임워크에서 마이그레이션할 때

빠른 시작

1. 1

   Node 22.12 이상이 설치되어 있는지 확인합니다

2. 2

   bun으로 xyd를 전역 설치합니다

   bun add -g xyd-js
3. 3

   개발 서버를 실행합니다

   xyd
4. 4

   정적 문서 파일을 빌드합니다

   xyd build

사용 전 알아둘 점

• !Node 22.12 이상이 필요합니다.

포함된 컬렉션

토픽

자주 묻는 질문

xyd은(는) 무엇인가요?

Markdown/MDX로 문서 사이트를 구축하고 OpenAPI 및 GraphQL API 문서를 생성하는 TypeScript 문서 프레임워크입니다. xyd는 TypeScript와 React로 만든 문서 프레임워크입니다. Markdown 및 MDX 콘텐츠를 문서 웹사이트로 변환하며, 별도 설정 없이 핫 리로드를 지원하는 개발 서버와 배포용 정적 파일을 빌드하는 명령어를 제공합니다.

xyd은(는) 무료로 사용할 수 있나요? 라이선스는 무엇인가요?

xyd은(는) MIT 라이선스의 오픈소스입니다. 상업용 제품에 사용하기 전에 라이선스 조건을 확인하세요.

xyd은(는) 아직 유지보수되고 있나요?

활발히 유지보수 중. xyd의 마지막 커밋은 2026년 10월 29일입니다.

xyd은(는) 어디에 사용할 수 있나요?

웹 애플리케이션의 제품 문서를 게시할 때 생성된 레퍼런스 페이지로 REST 또는 GraphQL API를 문서화할 때 API 문서와 함께 SDK를 제공하는 개발자 포털을 구축할 때 기존 문서 사이트를 다른 프레임워크에서 마이그레이션할 때

xyd는 어떻게 설치하나요?

Node 22.12 이상이 설치되어 있는지 확인합니다 bun으로 xyd를 전역 설치합니다: bun add -g xyd-js 개발 서버를 실행합니다: xyd 정적 문서 파일을 빌드합니다: xyd build

xyd은(는) 어디서 받을 수 있나요?

소스 코드와 설치 방법은 GitHub에 있습니다: https://github.com/livesession/xyd