[Git] Github Wiki 작성방법

Github Wiki를 사용하는 방법을 알아봅시다.

 

#페이지사용법

• [Wiki]탭으로 이동
• [New Page] 오른쪽 상단 New Page 버튼을 이용해서 페이지를 추가 할 수 있습니다.

 

#로컬편집방법

• 웹에서 페이지를 편집하는 일을 귀찮을 수 있습니다.
• Github는 Wiki에 대한 Repository를 제공하여 로컬에서 편집할 수 있습니다.
• [Clone this wiki locally] 오른쪽 하단 주소를 이용하여 git과 동일하게 Repository를 내려받을 수 있습니다.

 

git init

git clone <url> or git remote add origin <url>

 

• 아래는 Repository에서 생성된 파일목록입니다.
• 특수 기능을 가진 파일에 대해서는 `_` 문자를 이용하여 사용합니다.

 

 

#Pages&Sidebar

• Pages
• Pages는 구성된 모든 md 파일을 순서에 상관없이 보여줍니다.
• Sidebar
• `_Sidebar.md` 파일을 이용해서 목차를 만들 수 있습니다.
• 파일을 생성하고 _Sidebar.md 파일에 연결고리를 만들어줘 네이게이트를 할 수있도록 관리할 수 있습니다.

 

#Footer

• `_Footer.md`는 모든 페이지 하단에 공통적으로 처리할 수 있는 문구를 나타냅니다.
• 다국어정보 및 저작권 등등을 나타낼 수 있습니다.

 

 

#참고페이지

• [wiki 정리사례]  https://github.com/ethereum/wiki

• [github-wiki-sidebar] https://github.com/adriantanasa/github-wiki-sidebar/wiki