뒤로
심은광
심은광 ·

Docusaurus로 기술문서 만들어보세요 :)

최근 모노레포를 도입하면서 유틸 함수, 훅스 등을 공용화 하는 작업을 진행했었는데

하는 김에 문서화도 같이 진행하면 좋겠다는 생각이 들어서 이것저것 알아보다가 Docusaurus를 알게 되었습니다.

사용해 보니 너무 편하고 좋은 것 같아서 추천드립니다 !!

Docusaurus는 Meta에서 제공하는 오픈소스 문서 생성 도구로, React 기반으로 작동합니다.

너무나 깔끔한 기본 템플릿을 제공해주고 있고, 몇가지 설정만 해주면 바로 문서작성을 시작할 수 있습니다.

저는 로고 변경, 컬러 수정 등의 최소한의 커스텀 작업만 하고 바로 문서화를 시작했는데, 결과물이 생각보다 만족스러워서 추가적으로 커스텀을 하지 않아도 될 것 같아요.

스크린샷 2023-10-16 오후 11.15.34.png

Docusaurus는 Meta에서 제공하는 오픈소스인 만큼 공식문서가 굉장히 친절하게 되어있어서,

공식 문서 보시면 쉽게 활용하실 수 있으실 겁니다!!

공식 문서 링크 : https://docusaurus.io/

기술문서를 만드는 데 디자인이 고민되시거나,

빠르게 문서작성을 하고 싶으신 분들이 활용하시면 좋을 것 같아요 :)

혹시 더 매력적인 문서작성 도구를 알고 계시는 분이 있다면 .. 저도 알려주세요!! 감사합니다!!

0

댓글

로그인 후 댓글을 남길 수 있습니다.

아직 댓글이 없습니다.