(라인) 기술 문서 사이트로 Docusaurus 활용하기

• Static site generator(SSG)

  • 팀 공용 SSG를 선정해 사용한 경험

• Docs as cod와 SSG

  • 기술 문서를 소스 코드처럼 취급하고 관리하는 접근법

  • 특징 : Git을 이용한 버전 곤리와 테스트, 빌드, 배포 자동화

• 여러 SSG 종류

  • 1세대 SSG : 지킬, Gitbook

  • 2세대 SSG : 뷰프레스, 도쿠사우로스, 휴고

  • 웹 프레임워크 : Next.js, 개츠비, Nust, Astro

  • 기술 문서 작성용 & 커스터마이징 제약이 적은 것을 희망

  • 2세대 SSG : 리액트냐 뷰냐

• 기술 문서용 커스터마이징

  • 줄 바꿈 테이블

  • 용어집

  • API 레퍼런스

• 앞으로

  • 다른 사람들도 사용하려면 좀 더 쉽게 시작하는 방법이 필요

  • 누구나 복사해서 쓸 수 있는 기본 템플릿, 사용 안내서 등을 시도할 예정

• 생각

  • 저도 요즘 Docusaurus로 문서 만들고 있는데, 정말 간단하고 편합니다. 자바스크립트를 잘 모르지만 하나씩 하나씩 해보면서 만드는데 어려운 느낌이 크게 들진 않아요 :)

https://techblog.lycorp.co.jp/ko/docusaurus-as-a-technical-document-website