[Github] 깃허브 wiki 작성하기 (repository 문서화 / 인덱스화 / TIL )

나는 2020년 12월 말부터 1일1커밋을 진행 중이다.

 

1일 1커밋 4개월 동안 한 후기 (Github / 1일 1코딩 / 개발자 취준생)

 

현재 9개월간 진행해오면서 내 레포지터리에는 많은 내용이 쌓였다.

때문에 가끔 내가 뭘 공부했던가 기억이 나지 않는 경우도 있었다.

 

그래서 오늘 깃허브 wiki를 작성해보려한다.

 

Wiki 란?

쏘카 스터디를 하며 정말 가장 많이 들락날락했던 곳이 바로 exposed wiki이다.

 

Home · JetBrains/Exposed Wiki · GitHub

GitHub - JetBrains/Exposed: Kotlin SQL Framework

 

 

 

 

대충 이 내용을 보면 wiki가 뭔지 감이 올 것이다.

 

그럼 wiki란 사용 설명서인가? 

여기 exposed wiki에서는 사용설명서로 유저들에게 exposed의 사용법을 상세히 설명해줬다.

 

 

하지만 Spring boot의 wiki에서는 사용설명보다는 출시 노트 등을 적어뒀다.

 

Home · spring-projects/spring-boot Wiki · GitHub

GitHub - spring-projects/spring-boot: Spring Boot

 

 

 

즉 wiki는 레포지터리에서 기록을 남기는 것을 말한다. 

그 기록의 내용이 사용설명서 일 수도 있고 출시 노트일 수도 있다.

 

나는 내 레포에 올렸던 til 내용을 간단히 적는 방식으로 진행해보려한다.

 

 

사실 그냥 readme에 적어도 되지만 그냥 따로 나만의 <레포지터리 문서>를 만들고 싶었다.

 

 

 

Wiki 생성

 

 

본인의 레포의 wiki 에 들어가 그냥 만들면 된다. 

그냥 주어진 툴로 생성해도 되지만 markdown 문법으로 써도 된다.

 

readme 파일 작성시에는 markdown문법을 사용한다.

그냥 몇가지만 알면된다.

 

• 글씨 크기는 # 의 개수로 변경

 

• 목록은 + / - 로 생성

 

목록을 세부적으로 나눌때 중요한건 공백이다.

목록2에서 꼭 tab이나 스페이스바 2번을 띄워줘야 한다.

 

 

• 소스코드는 ``` 로 작성

 

``` 후 언어를 작성해줘도 되고 안해줘도 된다.

 

• 이미지 넣기

이슈를 만들어 사진을 끌어다 놓고 생긴 url 을 복사해 붙여넣으면 된다.

 

 

 

• 이모지 넣기

이모지는 이 사이트에서 복붙하면 된다.

 

🎁 Emoji cheat sheet for GitHub, Basecamp, Slack & more (webfx.com)

Emoji cheat sheet for GitHub, Basecamp and other services

 

 

 

한번 이렇게 인덱스화해서 만들어봤다.

완성은 아니고 꾸준히 업데이트해갈 예정이다.

https://github.com/recordbuffer/TIL/wiki

GitHub - recordbuffer/TIL: Today I Learned