Guide
마크다운 문법 정리
마크다운은 문서를 예쁘게 꾸미기 위한 언어라기보다, 텍스트를 오래 남기고 다시 찾기 쉽게 만드는 형식입니다. 그래서 자주 쓰는 문법 몇 가지만 정확히 익혀도 노트, 회의록, README, 스펙 문서를 대부분 처리할 수 있습니다.
가장 먼저 익힐 문법 6가지
- 제목:
#,##,###로 문서 구조를 나눕니다. - 목록:
-또는1.으로 할 일과 순서를 정리합니다. - 체크박스:
- [ ],- [x]로 액션 아이템을 관리합니다. - 링크:
[텍스트](URL)형식으로 참조를 남깁니다. - 코드: 인라인 코드는 백틱 하나, 여러 줄 코드는 백틱 세 개를 씁니다.
- 인용문:
>로 메모, 결론, 강조 문장을 분리합니다.
개발자가 특히 많이 쓰는 문법
개발 문서에서는 예쁜 포맷보다 구조와 검색성이 더 중요합니다. 실제로 자주 쓰는 건 체크리스트, 코드 블록, 링크, 표 정도입니다. 나머지는 필요할 때만 붙이면 됩니다.
# Sprint 14 회의록
## 결정 사항
1. 로그인 리팩터링은 이번 주 안에 마무리
2. 알림 기능은 다음 스프린트로 이월
## 액션 아이템
- [ ] 김지원: PR 정리
- [ ] 박소연: QA 시나리오 업데이트
## 참고 코드
```ts
startTransition(() => syncNotes());
```
Maku에서 특히 중요한 문법
Maku는 일반 Markdown 위에 위키링크와 백링크 흐름을 얹는 쪽에 강점이 있습니다. 그래서 문법 자체보다도, 문서를 서로 연결하는 습관이 더 중요합니다.
- 표준 Markdown 링크는 외부 문서나 웹 문서를 연결할 때 좋습니다.
- 위키링크는 내부 노트를 빠르게 연결할 때 좋습니다.
- 체크박스는 회의록과 일간 저널에서 액션 아이템을 찾기 쉽게 만듭니다.
문법을 익힌 다음 해야 할 일
문법을 다 외우는 것보다 더 중요한 건 실제 문서 템플릿에 바로 써보는 것입니다. 회의록, 일간 저널, 스펙 문서 같이 반복적으로 쓰는 형식을 하나 정해놓으면 Markdown은 금방 손에 익습니다.