마크다운을 알면 생기는 일 — 깃 밖에서 더 많이 씁니다
Article
운전면허를 떠올려봅니다. 대부분 이유는 하나입니다. 집에 있는 차를 몰아야 해서, 혹은 출퇴근이 급해서 땁니다. 그런데 막상 따고 나면 그 차만 모는 게 아닙니다. 여행 가서 렌터카를 빌리고, 이삿날 트럭을 빌리고, 회사 차를 몰게 됩니다. 면허를 딴 이유와, 면허를 실제로 쓰는 곳이 다릅니다.
마크다운이 딱 그렇습니다. 우리는 깃허브에 올릴 파일을 쓰려고 배웠습니다. 그런데 배우고 나면 깃허브 바깥에서 더 자주 씁니다. 오늘은 새 문법을 하나도 안 배웁니다. 11강과 12강에서 익힌 그 표기가 어디로 흘러가는지만 봅니다.
배운 이유와 쓸 데가 다릅니다
# 하나가 통하는 곳들| 어디 | 무엇에 쓰나 | 얼마나 자주 |
|---|---|---|
| 노션 · 옵시디언 | 회의록 · 공부 메모 · 할 일 | 거의 매일 |
깃허브 README.md | 저장소를 열면 뜨는 첫 화면 | 프로젝트마다 한 번 |
| AI 에게 주는 지시 문서 | 요구사항 · 규칙을 정리해서 던질 때 | 쓰기 시작하면 매일 |
| 기술 문서 · 이슈 · PR 설명 | 남에게 상황을 설명할 때 | 팀에 들어가면 매일 |
| 블로그 · 디스코드 · 슬랙 | 글 쓰고 메시지 보낼 때 | 생각보다 자주 |
이 목록이 길어 보이는 이유가 있습니다. 마크다운은 특정 회사의 물건이 아니라 공용 규격이기 때문입니다. 규격이 공용이니 도구들이 앞다퉈 지원했고, 지원하다 보니 더 널리 퍼졌습니다.
워드 · 한글 문서
그 프로그램 안에서만 산다
- 열려면 그 프로그램이 있어야 한다
- 복사해서 다른 데 붙이면 모양이 깨진다
- 글자 크기를 마우스로 하나하나 지정한다
- 버전이 다르면 안 열리기도 한다
마크다운 파일
그냥 글자 파일이다
- 메모장으로도 열린다
- 붙여 넣으면 대부분 모양까지 살아난다
#하나로 제목이 된다 — 마우스가 필요 없다- 10년 뒤에도 열린다
노션과 옵시디언 — 오늘 당장 써먹을 데
메모 도구를 하나라도 쓰고 있다면 오늘 바로 효과가 납니다. 노션에서 # 를 치고 한 칸 띄우면 그 줄이 제목으로 바뀝니다. - 를 치고 한 칸 띄우면 목록이 되고, 별표 두 개로 감싸면 굵어집니다. 마우스로 메뉴를 뒤질 일이 사라집니다.
- 마우스로 쓰기글자 입력 → 마우스로 메뉴 → 제목 선택 → 다시 키보드
- 마크다운으로 쓰기
#한 칸 띄우고 계속 입력 — 손이 키보드를 안 떠난다
옵시디언은 아예 파일 자체가 .md 입니다. 노션은 마크다운 표기를 입력 방식으로 받아들이는 쪽이고, 옵시디언은 저장 형식이 마크다운입니다. 이 차이가 중요한 순간이 한 번 옵니다. 서비스를 옮길 때입니다.
README.md — 저장소를 열면 제일 먼저 보이는 것
깃허브에서 남의 저장소에 들어가면, 파일 목록 아래에 긴 설명이 붙어 있는 걸 보게 됩니다. 그게 README.md 입니다. 깃허브는 폴더에 README.md 가 있으면 그 내용을 화면에 펼쳐서 보여줍니다.
- my-first-repo/
- README.md
- memo.md
- .gitignore
이름부터 그렇습니다. "읽어라" 입니다. 이 프로젝트가 무엇이고, 어떻게 쓰는지를 적어두는 자리입니다. 지금은 혼자 쓰는 메모 저장소라 별 내용이 없지만, 나중에 만든 걸 남에게 보여줄 때 이 파일이 사실상 그 프로젝트의 얼굴이 됩니다.
AI 에게 주는 지시 문서
요즘 부쩍 늘어난 쓸 자리입니다. 챗봇에 질문을 던져보면 답이 제목과 목록으로 정리돼서 나옵니다. 그게 마크다운입니다. AI 가 마크다운으로 답하는 이유는, 학습한 글의 상당수가 마크다운으로 쓰여 있어서입니다.
반대 방향도 통합니다. 요구사항을 줄글로 길게 던지는 대신 구조를 갖춰 주면 훨씬 잘 알아듣습니다.
줄글로 던지기
한 문단에 다 몰아넣는다
- "메모 정리해주는데 제목 붙이고 할 일은 따로 빼고 급한 건 위로 올리고 어제 것도 같이..."
- 어디까지가 조건이고 어디부터가 예시인지 안 보인다
- 빠뜨린 걸 나중에 덧붙이면 앞말과 섞인다
마크다운으로 던지기
제목으로 나누고 목록으로 편다
## 해야 할 일아래에 목록으로 항목을 편다## 지켜야 할 것아래에 조건을 따로 모은다- 고칠 때 해당 줄만 고친다
코딩을 돕는 AI 도구들은 아예 프로젝트 폴더 안의 마크다운 파일을 규칙서로 읽습니다. "이 프로젝트에서는 이런 식으로 쓴다" 를 파일에 적어두면 매번 설명하지 않아도 됩니다. 지금 배우는 표기가 그대로 쓰입니다.
남에게 상황을 설명할 때
팀에 들어가면 하루에 몇 번씩 하게 되는 일입니다. 뭐가 안 된다고 알리고, 무엇을 고쳤는지 설명합니다. 이때도 마크다운입니다. 깃허브의 이슈와 PR 설명란이 전부 마크다운을 받습니다. 여기는 24강에서 직접 써봅니다.
| 표기 | 이럴 때 쓴다 |
|---|---|
| 코드 블록 | 에러 메시지를 원문 그대로 붙일 때 — 제일 많이 쓴다 |
| 체크박스 | 남은 일을 나열하고 하나씩 지울 때 |
인용 > | 남이 한 말을 옮겨 놓고 답할 때 |
| 목록 | 재현 순서를 1·2·3 으로 적을 때 |
에러 메시지를 그림으로 찍어 올리면 도와주려는 사람이 그걸 검색창에 옮겨 칠 수가 없습니다. 코드 블록으로 붙이면 복사해서 바로 찾아봅니다. 사소해 보이지만 실제로 답이 돌아오는 속도가 달라집니다.
오늘 바로 해봅니다
12강에서 완성한 memo.md 가 있습니다. 그걸 그대로 메모 도구에 옮겨봅니다. 새로 배울 게 없어서 3분이면 끝납니다.
- 01
memo.md를 메모장으로 엽니다12강까지 채운 제목 · 목록 · 표 · 체크박스가 표기 그대로 보입니다
- 02
전체 선택해서 복사합니다
Ctrl+A로 전체 선택,Ctrl+C로 복사 - 03
쓰는 메모 도구에 새 문서를 만들고 붙여 넣습니다
노션 · 옵시디언 · 슬랙 어디든 됩니다. 계정이 없으면 이 단계는 영상에서 보는 걸로 대신합니다
- 04
무엇이 살아났는지 봅니다
#은 제목이 되고-는 목록이 됩니다. 도구에 따라 표는 살고 체크박스는 안 살기도 합니다 - 05
안 살아난 게 있으면 그게 12강에서 말한 GFM 입니다
표와 체크박스는 깃허브가 덧붙인 문법이라 지원하지 않는 도구가 있습니다
Part 3 을 닫습니다
세 강 동안 깃 명령어는 거의 안 쳤습니다. 그래도 이 자리에 마크다운을 넣은 이유가 있습니다. 다음 강부터 올릴 파일이 마크다운이고, 20강에서 웹페이지로 만들 것도 마크다운이고, 24강에서 남에게 설명할 글도 마크다운입니다. 여기서 안 배우면 뒤에서 세 번 막힙니다.
- $ git log --oneline
- a4c81d6 (HEAD -> master) 메모에 할 일 목록과 명령어 표 추가
- 9b30e77 메모에 제목과 목록 표기 적용
- d6a25f1 메모 파일을 마크다운으로 전환
- e2f9c40 메모 마지막 줄 문구 변경
- 5a7b3f2 제외 규칙 추가
- 1c4e8b9 메모 파일 추가
여기까지가 전부 내 컴퓨터 안입니다. 인터넷에는 아직 아무것도 없습니다.
정리하면
- 오늘은 새 문법을 하나도 안 배웠습니다. 11 · 12강에서 배운 표기를 쓸 데만 봤습니다
- 마크다운은 특정 회사 물건이 아니라 공용 규격입니다. 그래서 여러 도구에서 통합니다
- 노션 · 옵시디언에서
#와-를 치면 손이 키보드를 안 떠납니다. 오늘 당장 효과가 납니다 - 파일 자체가 마크다운이면 서비스를 옮길 때 폴더째 옮기면 됩니다
README.md는 저장소를 열면 자동으로 펼쳐지는 파일입니다. 사실상 프로젝트의 얼굴입니다- AI 에게 요구사항을 줄 때도 제목과 목록으로 나눠 주면 훨씬 잘 통합니다
- 에러는 그림으로 찍지 말고 코드 블록으로 붙입니다. 받는 도움의 양이 달라집니다
- 도구마다 지원 범위가 다릅니다. 남에게 줄 문서는 기본 다섯 개 안에서 쓰는 게 안전합니다
Part 3 이 끝났습니다. 11강에서 화장 안 한 문서가 뭔지 보고, 12강에서 나머지 문법을 선반에 채우고, 오늘 그 선반을 어디서 여는지까지 왔습니다. 깃을 잠깐 내려놨던 세 강이 여기서 마무리됩니다.
다음 14강부터 Part 4 입니다. 드디어 인터넷으로 나갑니다. 3강에서 "깃과 깃허브는 다른 물건" 이라고 해두고 미뤄뒀던 이야기를 여기서 받습니다. 내 컴퓨터의 저장소와 깃허브의 저장소를 줄로 잇고, 지금까지 쌓은 커밋을 통째로 부칩니다. 창고에 택배를 부치는 것이라고 생각하면 됩니다. memo.md 는 이때 README.md 로 이름을 바꿔 올라갑니다.