gitbook 활용해보기

gitbook

  • github와 연동한 클라우드 서비스가 있으나 그것을 사용하려고 하는 것이 아니다.

문서화의 구조적인 편집을 위한 도구

  • gitbook
    -markdown지원

    • 다양한 플러그인 : plantuml, include-highlight
  • nodejs 설치 후 npm으로 gitbook-cli의 기본 설치과정을 마치면 로컬 웹서버가 동작한다.

장점:

  • 어떤 편집기로든 편집이 가능
  • 브라우져를 띄워 놓으면 자동으로 재 생성하면서 리로드가 됨(완벽한 preview)
  • 추후 책으로 출판이 가능함.

한마디

doxygen으로 코드 문서화를 계속 해보았지만 레퍼런스 문서는 실제 개발하면서 api레벨 작업보다 변화가 많아서 활용성이 떨어졌다. gitbook을 로컬에서 사용하고 소스저장소와 함께 활용해보니 팀내 문서 공유에 많은 도움이 됨.

간만에 득템!!