기본 패턴
text
Markdown는 가볍고 읽기 쉬운 문법입니다.[^1]
[^1]: 자세한 배경 설명이나 출처를 적습니다.설명
- 각주는 본문에서 짧게 표시하고, 자세한 설명은 문서 아래로 보내는 방식입니다.
- 본문 흐름을 해치지 않으면서 출처, 보충 설명, 예외 사항을 붙일 수 있습니다.
- GitHub Flavored Markdown은 각주 문법을 지원하므로 README나 설명 문서에서도 활용할 수 있습니다.
- 다만 지나치게 많은 각주는 다시 오가는 비용을 만들 수 있으니 필요한 경우에만 쓰는 편이 좋습니다.
짧은 예제
text
이 프로젝트는 실험 기능을 포함합니다.[^beta]
[^beta]: 안정 API가 아니므로 버전 업그레이드 때 동작이 달라질 수 있습니다.빠른 정리
| 항목 | 설명 |
|---|---|
[^id] | 본문에서 각주를 참조 |
[^id]: 내용 | 각주 본문 정의 |
| 보충 설명 | 본문을 과하게 길게 만들지 않음 |
| 출처 표기 | 문장 흐름을 유지한 채 참고 정보 연결 |
| 사용 절제 | 너무 많으면 문서 집중력이 떨어질 수 있음 |
주의할 점
핵심 설명까지 각주로 보내면 독자가 본문에서 바로 이해하기 어려워집니다. 각주는 어디까지나 보충 정보라는 기준을 유지하는 편이 좋습니다.
참고 링크
2 sources