깃허브 Wiki

서론

     Wiki는 GitHub 저장소에서 간단한 문서를 작성하고 관리할 수 있는 기능이다. Wiki를 사용하면 저장소와 관련된 문서를 쉽게 작성하고 공유할 수 있다. Markdown(마크다운) 형식을 사용하여 문서를 작성한다. 저장소의 협업 기능과 함께 작동하여, 저장소의 모든 참여자가 문서를 수정하고 개선할 수 있다. Wiki를 통해 저장소와 관련된 정보를 효율적으로 관리할 수 있으며, 팀원 간의 의사소통과 지식 공유를 쉽게 할 수 있다.

---

Wiki

세팅하기

      wiki창이 없다면 "Settings">"General">"Features">"wiki"로 위키창을 활성화할 수 있다. 아래에 "Restrict editing to collaborators only"를 통하여 공용 작업자만이 작업을 할 수 있게 제한을 할 수 있다.(공동 작업자가 아니어도 보는 것은 가능하다.)

생성하기

    처음에는 "Create the first page"를 통해 wiki 문서를 작성할 수 있다.

    첫 생성 시 "Home"이라는 페이지로 디폴트로 설정되어 있지만, 편집이 가능하다.

    생성 시 첫 위키를 첫 화면으로 설정이 된다. 이제 새로운 위키를 만들 때 "New page"버튼을 클릭하면 된다.

기타

     Page는 만들어진 모든 위키를 볼 수 있다. 위키들은 첫 위키를 제외한 알파벳, 한글 순으로 정렬된다. 더 깔끔하게 보기 위해서 "+ Add a custom sidebar"를 통해 정리할 수 있다. 

    "Clone this wiki locally"은 GitHub Wiki의 문서를 로컬 컴퓨터로 복제하여 작업할 수 있는 기능이다. 로컬 컴퓨터에서 Wiki를 수정하고 업로드하면, 해당 저장소의 Wiki 페이지에 변경 사항이 반영된다. 이를 통해 여러 사람이 함께 문서를 수정하고 개선할 수 있다.

 그외에 "Edit"을 통해 해당 위키가 변경된 과정을 볼 수 있으며, 삭제도 가능하다.

---

사용 방법

     홈에 모든 것을 연결하거나, 슬라이드 바를 통해 카테고리 별로 정리하여 사용된다.

---

주섬주섬

     문서 부분은 회의록 혹은 개별 일지를 제외한 기획 관련 부분은 완전히 완성된 후 위키에 문서로 만들어 두는 것이 좋다.

참고

커뮤니티 문서 작성 - GitHub Docs