Github Wiki 작성하기

Github Wiki

위키를 왜 만들까요

나 같은 경우엔 노션을 따로 정리하더라도 깃허브에 더 자주 들르게 되고, 따라서 깃허브에 최대한 할 일이나 각종 문서들을 저장하는 것이 좋겠다는 생각이 들었다

팀 노션 들어가있는 곳도 워낙 많고... 코딩 컨벤션과 같이 자주 체크해야 하는 항목들은 깃허브에 붙여놓는 것이 훨씬 좋겠다는 생각이 들어 위키를 작성해두게 되었다

위키 생성하기

프라이빗 레포의 위키 생성은 아쉽게도 유료이다 (단발성 프로젝트에서 돈을 내기엔 애매하다..)

어차피 나중에 채점을 진행해야 하니 퍼블릭으로 돌려놓으면 Wikis 항목을 활성화할 수 있다

Wikis 항목의 체크박스를 체크해 활성화시키면 레포지토리의 상단에 Wiki 탭이 생긴다

와~ 위키가 생겼다

첫 페이지가 자동으로 생성된다

페이지 추가하기

New Page를 눌러보자

페이지를 추가할 수 있는 창이 나온다

마크다운 문법을 지원하기 때문에 평소에 마크다운에 익숙하다면 알찬 페이지를 구성할 수 있다

그 외에도 여러 문법을 지원하며, Edit Mode로 조정할 수 있다

필자는 마크다운 외엔 잘 모르므로 마크다운으로 문서를 작성해보도록 하겠다

Github Readme와 비슷한 형식으로 문서가 완성되었다

사이드바 커스텀하기

페이지가 많아지면 페이지를 카테고리별로 나눠서 보기 어려워진다

사이드바를 커스텀해서 페이지를 트리 형식으로나마 배치해볼 수 있다

Add a custom sidebar를 누르자

마크다운 형식의 작성 페이지가 나온다

간단하게 카테고리를 구성해 보자

Pages가 자동으로 접히고, 위에서 구성한 마크다운이 조그맣게 출력된다

얼추 트리 구조를 따라할 수 있어 보기가 한결 나아졌다

결론

노션이나 Jira 등의 협업 툴을 사용한다면 자료를 훨씬 정돈된 형태로 정리할 수 있기 때문에 깃허브 위키가 크게 와닿지 않을 수 있으나, 코드 관련 작업을 하면서 자주 볼 만한 문서는 위키에 정리해 두면 깃허브 내에서 바로 확인이 가능하기 때문에 접근성이 뛰어난 장점이 있다

또한 README.md를 폴더별로 중구난방하게 만드는 것보단 위키 내에서 모든 페이지를 확인할 수 있도록 만드는 것이 접근성 면에서도 더 뛰어나다

프로젝트의 소개나 사용자 매뉴얼 등도 위키로 작성하여 코드를 사용하는 사람들이 쉽게 접근할 수 있고, 코드에 기여하려는 사람들에게도 도움이 되는 좋은 기능이라고 할 수 있겠다