realm/jazzy

어떤 프로젝트인가요?

핵심 기능

• 01Clang 및 SourceKit AST와 문서 주석을 읽어 문서를 생성합니다.
• 02Xcode 및 Swift Package Manager 프로젝트와 Objective-C를 지원합니다.
• 03심볼 그래프를 통해 컴파일된 Swift 모듈에서 문서를 생성할 수 있습니다.
• 04여러 모듈을 모듈 간 링크 기능을 갖춘 하나의 사이트로 통합합니다.
• 05KaTeX로 LaTeX 수식을 렌더링하고 Markdown 가이드를 포함합니다.
• 06Dash docset을 생성하며 기본 테마 3종을 제공합니다.

활용 사례

• Swift 프레임워크나 SDK의 API 레퍼런스 문서를 공개할 때.
• umbrella header가 있는 Objective-C 라이브러리를 문서화할 때.
• 앱과 확장 프로그램의 문서를 하나의 사이트로 생성할 때.
• 오프라인 문서를 Dash docset으로 만들 때.

빠른 시작

1. 1

   RubyGems로 jazzy를 설치하세요

   [sudo] gem install jazzy
2. 2

   Swift 프로젝트의 루트에서 jazzy를 실행하세요

   jazzy

사용 전 알아둘 점

• !Jazzy는 macOS에서 실행하도록 설계되었습니다. Linux에서 사용하려면 README의 추가 안내가 필요합니다.

포함된 컬렉션

토픽

자주 묻는 질문

jazzy은(는) 무엇인가요?

Swift 및 Objective-C 프로젝트의 Apple 스타일 HTML API 문서를 생성하는 명령줄 도구입니다. jazzy는 Swift 및 Objective-C 코드의 API 레퍼런스 문서를 생성합니다. 소스 파일을 직접 파싱하는 대신 Clang과 SourceKit을 사용해 코드의 AST와 문서 주석을 읽어 정확한 결과를 만드는 것을 목표로 합니다. 생성된 페이지는 Apple 공식 레퍼런스 문서와 비슷한 디자인을 갖습니다.

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

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

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

6개월 이내 업데이트. jazzy의 마지막 커밋은 2026년 10월 1일입니다.

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

Swift 프레임워크나 SDK의 API 레퍼런스 문서를 공개할 때. umbrella header가 있는 Objective-C 라이브러리를 문서화할 때. 앱과 확장 프로그램의 문서를 하나의 사이트로 생성할 때. 오프라인 문서를 Dash docset으로 만들 때.

jazzy는 어떻게 설치하나요?

RubyGems로 jazzy를 설치하세요: [sudo] gem install jazzy Swift 프로젝트의 루트에서 jazzy를 실행하세요: jazzy

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

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