스위프트 패키지를 위한 DocC 카탈로그 생성부터 깃헙페이지 배포까지
2 min readNov 4, 2023
2년전 사이드 프로젝트에서 스위프트 패키지를 위한 DocC 기반 문서를 배포할 때 필요한 정보들이 파편처럼 흩어져 있어서 공부하는 데 불편함을 느꼈습니다. 나중에 한 곳에 모아 정리해야지 하고 미루다가 백수가 되어서야 하나의 레포지토리에 정리해보았습니다.
현재 레포지토리에서 제공하는 내용은 다음과 같습니다.
- 스위프트 패키지를 위한 DocC를 생성하는 것
- docc-plugin 에 대한 설명과 사용 시 마주할 수 있는 한계점과 해결책
- xcodebuild 커맨드라인 도구로 문서 빌드를 하는 이유와 방법
- GitHub Pages 에 배포하는 여러 방법들과 마주할 수 있는 이슈
- 쉘 스크립트 파일, 깃헙 워크플로우, 문서카탈로그 등 실제 코드와 설명
꼭 스위프트 패키지를 위한 상황이 아니더라도 DocC 문서를 빌드하고 배포하는 과정에 대해 지식을 얻고자 하는 분들께 도움이 될 거라 생각합니다.
이슈 레포트나 PR 은 늘 환영입니다!
뿅
