😉[Markdown] README, TIL 작성 시 사용할 문법

Github Docs - Basic writing and formatting syntax 를 참고.
더 많은 예시를 보고 싶다면 GitHub Flavored Markdown

---

분명 저번 캡디 때 최종 보고서를 쓰면서 README.md 를 내가 작성했는데 몇 달 안썼다고 거의 다 까먹어버렸다.🙃
그렇다. 그 때 공부해서 잘 작성했어도 정리를 안해두니 이렇게 또 고생을 하고 있지 않은가? 공부하면서 이런 리셋을 한 두 번 경험한 게 아니였기에 이런 고생, 후회 덜 하려고 평소 내 생각을 습관적으로 기록하게 됐고 TIL을 작성하기로 한 결정에 이 점도 한 몫 하는 거 같다.

이번 같은 일을 방지하기 위해 이 포스트를 작성하게 되었다.

---

작업 목록(check-box)

To Do list 같은 작업 목록을 만들려면 - [ ]을 사용하면 된다.
작업을 완료 상태는 괄호 사이에 x를 넣어 표현할 수 있고
괄호가 맨 앞에 오게 된 경우, 그 앞에 \를 붙여 처리하자.

- [x] 지도교수 상담확인서 제출
- [ ] TIL 작성
- [ ] \(컨디션 좋으면) 자기 전 홈트

• 지도교수 상담확인서 제출
• TIL 작성하기
• (컨디션 좋으면) 자기 전 홈트

---

사용자 태그

Instagram, Twitter같은 SNS를 사용해봤다면 익숙한 기능일 거다.
같이 협업하는 팀원이나 팀을 언급하고 싶을 땐 @를 사용하자.

@github/support What do you think about these updates?

---

이모지

딱딱한 글자들 사이에 1g의 말랑함을 더해주는 건, 이모지
깃허브에서 글을 쓰다가 이모지를 넣고 싶으면:EMOJICODE:를 사용하면 된다.

github 이모지 목록

---

로컬 이미지 업로드

github에서 readme를 작성할 때는 로컬에 있는 이미지를 복붙만 해도 바로 이미지 경로가 생성되지만 그렇지 않을 경우에는 github Issues를 이용하면 된다

github Issues로 이미지 경로 쉽게 얻기

repository 하나를 선택 > Issues > New Issue > Write영역에 로컬에서 복사한 이미지 붙여넣기 하면 자동으로 이미지 경로를 얻을 수 있다.

---

VSCode에서 Markdown 작성

미리보기

Ctrl + K + V 를 누르거나 좌측 상단에 돋보기 아이콘 클릭하면 작성중인 마크다운을 미리보기할 수 있다.

이모지 사용

확장 > Markdown Emoji 다운로드

---

TIL 쓰러 가야해서 여기까지 쓰지만 틈틈이 내용 추가 예정.