[Github] TIL 작성법

* TIL?

Today I Learned의 약자.

그날그날 내가 공부한 것을 정리하는 것이다.

미국에서는 흔하게 사용되는 용어인데 아직 한국에서는 많이 사용되지않고 개발자들 사이에서만 사용되고 있다고 한다.

 

* TIL 참고 예시

1. 진유림님 TIL :  milooy.github.io/TIL/ (프론트개발자분)

2. 김남윤님 TIL :  github.com/cheese10yun/TIL

3. 초보몽키님 TIL : https://wayhome25.github.io/

 진유림님d이나 초보몽키님 처럼 꼭 github의 형태로 할 필요는 없다. 하지만 나는 github이 일단 편하게 느껴졌고 위키피디아처럼 이루어져 한눈에 잘 들어온다는 점이 좋았다. 또한 면접에서 나중에 잘 어필할 수 있을 것이란 생각이 들어서 github을 선택하게 되었다.

 

 위의 TIL들을 참고해서 만들었던 나의 TIL(https://github.com/mangdo/TIL)이다. 하루씩 모으다보니 지금은 나름? 쌓이게 되었다. 사실 요즘엔 팀프로젝트 일정이 있어 못 올릴때가 많고, 알고리즘 문제는 아예 다른 리포지토리에 올리고 있다. 짧지만 TIL을 적게되면서 느끼는 점은 "TIL에는 정해진 형식이 없다"라는 것이다. 그냥 이건 다 예시고 자기가 좋아하는 방법으로 하는게 맞는 것같다. 그래야 꾸준히 쓰게된다. 예시들은 대부분 topic으로 TIL을 작성했는데, 초보몽키님(https://wayhome25.github.io/til/2017/03/09/TIL/) 처럼 일기 형식으로 적는 분들도 많다. 

 

 

 

* Github으로 TIL 시작하기

1. 레포지토리 생성

우선 자신의 github계정을 만들고 Respositories의 New버튼을 클릭한다.

나의 경우에는 계정이 원래 있었으므로 원계정에 만들었다.

 

 

리드미 파일을 꼭 추가하자!

 

2. 레포지토리 생성 확인

바로 여기서 Add file을 만들어쓰고 README.md옆에 연필버튼을 사용해서 작성하면된다.

근데 이렇게 사용하게되면 한 파일을 수정할때마다 1커밋을 해야했다.

그니까 spring폴더에 controller이라는 글을 작성하고 1커밋하고, 다시 README.md에서 controller글의 링크를 걸면서 또 다른 1커밋을 해야했다. 의미없는 커밋이 늘어나는 것같아서 이 방법이 아닌 다른 방법을 생각해보았다.

 

3. 툴을 사용하여 README.md 편집하기

이클립스를 이용하거나 Visual Studio Code를 사용해서 README.md를 편집하고 이를 push하는 방법이다.

 

1) 이클립스

이클립스를 사용할때에는 help>ecliplse Marketplace에 들어가서 markdown을 검색한다.

그러면 두번째쯤에 github Flavored Markdown viewer plugin 1.8.3이 있는데

이것을 설치하면 된다. 이를 통해서 README.md를 편집하고 push하면된다.

다음으론 이제 Show view에서 GFM View를 추가해준다.

preview가 지원되긴하나 부족하니까 GFM을 이용하자

현재 내가 진행하고 있는 프로젝트의 리드미이다.

그럼 이제 이런 방식으로 나오게 되고 리드미들을 편집하고 싶은 만큼 편집하고 commit&push를 해주면된다!

 

2) VS code (추천!!)

개인적으론 VS code가 가볍고 편하다고 느껴서 나의 경우에는 VS code를 이용했다.

md파일을 열게 되면 상단 오른쪽에  open preview to side버튼이 있다. (단축키 : ctrl+ K V)

 

이렇게 보면서 작성하면된다.

 

 

만약 VS Code에서 git clone & commit & push를 모른다면?

VS Code에서 git clone 하기

VS Code에서 git commit & push 하기