본문 바로가기
협업/GitHub

GitHub - wiki에 대해 알아보자

by 퐁고 2022. 9. 16.
반응형

Wiki

  • 개발하고 잇는 소스코드를 코드 탭에 올리고 우리가 프로젝트를 진행하며 문서 작업을 할 수 있는데 이 문서 작업을 할 수 있는 탭이 위키입니다.
  • 프로젝트에 대한 설명을 추가하는 것 등 다양한 일을 할 수 있습니다.
  • README가 소개와 개요라면 Wiki는 사용설명서와 같은 것입니다.
  • 많은 사람들이 함께 만들 수 있습니다.
  • markdown 문법으로 사용 가능합니다.

 

위키를 잘 쓰려면 먼저 README, MARKDOWN 문법에 대해서 알아야합니다. 아래 포스팅을 참고해 주세요!

 

GitHub - README, 마크다운 문법 알아보기

README란? README는 쉽게 말해서 프로젝트 소개글이라고 할 수 있습니다. 일반적으로 디렉토리나 압축 파일에 포함된 기타 파일에 대한 정보를 포함하고 있으며, 일반적으로 소프트웨어와 함께 배

pongo.tistory.com

 

Wiki 생성하기

깃허브 리포지토리에 들어가 Wiki를 생성합니다.

Create the first page를 눌러줍니다.

Wiki 작성도 기본적인 마크다운 문법을 사용함으로 README 처럼 써줍니다.

Home은 메인 페이지라고 보시면 됩니다!

마크다운 문법을 사용합니다.
메인 페이지가 생성되었습니다!

 

README를 써보셨고, 마크다운 문법을 안다면 매우 쉽습니다.

 

여기서 끝이면 README와 다를게 없겠죠? Wiki는 README와 다르게 사이드 바와 푸터라는 걸 생성 할 수 있습니다!

오른쪽 ADD a custom sidebar를 클릭하여 생성해줍니다.

여기서 절대 제목을 건드리시지 마세요! ❌  _Sidebar를 수정하시면 사이드바가 생성되지않고 Home과 같은 새로운 페이지를 생성합니다.

사이드 바가 생성되었습니다.

푸터 역시 똑같이 생성해줍니다. 푸터 역시 절대 제목을 건드리시면 안됩니다! ❌  _Footer를 수정하시면 푸터가 생성되지 않고 Home과 같은 페이지가 생성됩니다.

 

Add a custom footer를 클릭해줍니다.

푸터까지 생성하였고 이제 위키를 입맛대로 꾸미시면 됩니다!

 

댓글