기술 문서 사이트로 Docusaurus 활용하기

이 게시물은 LINE의 문서 엔지니어링 경험을 바탕으로 팀 공용 SSG인 Docusaurus를 선정하고 커스터마이징한 과정을 공유합니다.

SSG 선정 배경과 기준

• 기본 문서 기능 충실 및 새 기능 자유 추가 가능
• docs as code 방식을 지원하며 React 기반을 선호
• 2세대 SSG 중 Docusaurus를 선택, VuePress도 대안으로 언급

커스터마이징 사례

• Markdown 표 내 줄 바꿈과 목록 처리 위해 MultilineTable 컴포넌트 개발
• 용어집과 API 문서용 YAML 데이터 관리 및 전역 컴포넌트 구현
• 문서 뷰와 데이터를 분리해 작업 효율 극대화

향후 계획

• 사용자 편의를 위한 템플릿 및 안내서 마련 예정
• 필요 시 다른 SSG로의 유연한 전환도 고려