깃허브(github)로 TIL 작성하기

앞으로 간단한 TIL는 깃허브로 작성하기로 해서 깃허브에 TIL를 만들었다.
그 과정을 기록 해두고, 나와 같이 깃허브로 TIL를 처음 써보려는 분들에게 조금이나마 도움이 됐으면 하는 바람으로 정리!

 

TIL가 무엇인지, 나는 왜 깃허브에서 TIL를 작성하려는지에 대한 내용은 아래의 포스팅을 통해 확인하실 수 있습니다!

앞으로 내 블로그 운영 방향 (깃허브 TIL 분리 등)

 

---

1. 깃허브에 TIL Repository 만들기

우선 TIL를 보관할 Repository를 생성해 줘야 한다.

1. 내 깃허브에서 상단 'Repository/'를 클릭해주고 우측 상단에 있는 [New]를 클릭해준다.

 

2. Repository name에 어떤 이름을 사용할지 입력해주고 (나는 이미 'TIL'란 이름으로 만들어 놔서 안된다고 뜨는 것;)

하단에 Add a README file을 체크해준다. 

나머지 사항들은 필수 입력 사항이 아니라 개개인의 필요에 의해 작성해주면 됨

---

[선택사항]

1. Description (프로젝트 설명글) : 써도 되고 안써도 되고, 지금 써도 되지만 나중에 수정이 가능함

2. Public, private (공개여부) : 내가 작성한 TIL을 남들에게 보여줄지 말지 고르는 거라서 개개인의 선택에 맞춰 선택하면 됨.

3. README (메인 페이지 만들거야 말꺼야) : read me 파일 같은 경우도 보편적으로 TIL를 작성 하는 사람들은 만들어 주는 부분이고, 그룹화하고 정리하기위해 필요한데 이것도 개개인의 선택에 맞춰 만들어 주면 되긴 함.

 

 

(+) Readme 는 왜 만들어 주나요?

README의 경우 앞서 '선택사항'이라고 하긴 했는데 그럼에도 대부분 TIL를 작성하시는 분들이 README를 만드는 이유는 목차 혹은 인덱스 같은 거라고 생각하면 편하다. 내가 공부한 것들을 하나의 목차로 만들어서 첫 페이지에 정리해두면 나중에 꺼내보기도 편하기 때문에.

위 이미지가 내 TIL의 README인데 TIL를 만든지 얼마 안되서 목차랄 게 없지만 앞으로 차곡차곡 쌓아나갈 예정.

---

 

3. 그럼 일단 TIL Repository 생성 완료!

 

---

2. TIL 작성하기

이제 TIL를 작성하기만 하면되는데 작성법은 크게 2가지로 나뉜다.

1. 깃허브에서 TIL 작성하기 (가장 간편하나, 작은 수정도 하나의 커밋으로 봐서 불필요한 커밋이 있을 수 있다.)

2. VS Code같은 IDEA을 사용해서 TIL 작성하기 (플러그인을 활용하면 마크다운 미리보기를 실시간으로 사용할 수 있어 작성시에 편리하고, 커밋을 내가 원하는 단위로 묶어 할 수 있다. 그러나 어쨌든 IDEA와 마크다운 관련 플러그인을 설치해야 한다는 단점이 있음.)

나는 두 가지 방법을 모두 간단하게 정리해볼 예정!

---

2-1. 깃허브에서 TIL 작성하기

1. TIL Repository의 우측 초록색 버튼 [Code]를 클릭함.

 

2. 위와 같은 창이 뜨는데 위의 칸에는 파일명 아래 칸에는 정리한 내용을 작성하면 된다.

 

---

2-2.  IDEA를 활용하여 TIL 작성하기 (VS Code)

사실 작성하는데에는 어떤 IDEA도 상관없는데 나는 원래 인텔리제이와 이클립스를 주로 쓰지만 VS Code도 경험해볼 겸 VS Code를 선택했고, VS Code를 기준으로 작성했다.

 

1. 좌측 세로 메뉴 중, 가장 마지막 아이콘을 클릭하면 플러그인을 설치할 수 있는 '마켓플레이스'가 뜨는데,

여기에 'markdown all in one'을 검색해서 다운로드 받아준다.

 

1. 첫번째 이미지 처럼 우측에 아이콘을 클릭하면 바로 위 이미지 처럼 미리보기가 뜨면서 실시간으로 마크다운이 어떻게 적용되는지 확인 가능하다.

 

 

---

(+) 새 파일을 만들어 줄 땐 반드시 .md 확장자로 하기!

.md는 마크다운 확장자로, 우리는 마크다운 형식으로 작성하기 때문에 확장자를 반드시 .md로 해야 마크다운 적용이 가능하다!

---

(+) VS Code설치와 프로젝트 clone, commit, pull, push 간단한 사용법은 아래의 포스팅을 통해 따로 정리 해두었다.