기본 패턴
text
[공식 문서][docs]
[API 문서][docs]
[docs]: https://example.com "설명"설명
- 참조형 링크는 본문에서는 짧은 식별자만 쓰고, 실제 URL은 아래쪽 정의 블록에 모아 두는 방식입니다.
- 같은 링크가 여러 번 반복되는 문서나 URL이 긴 문서에서 특히 읽기 좋습니다.
- 링크 정의를 모아 두면 본문이 깨끗해지고, 나중에 URL을 바꿀 때 수정 위치도 줄어듭니다.
- CommonMark 기준으로 링크 정의는 문서 다른 위치에 있어도 인식될 수 있습니다.
짧은 예제
text
자세한 설명은 [설치 가이드][install]를 보고,
명령어 목록은 [CLI 문서][install]와 함께 확인합니다.
[install]: https://example.com/install빠른 정리
| 항목 | 설명 |
|---|---|
[text][id] | 본문에서 보이는 링크 표현 |
[id]: url | 아래쪽에 두는 링크 정의 |
| URL 분리 | 본문 가독성이 좋아짐 |
| 반복 링크 | 같은 대상을 여러 번 연결할 때 특히 유리 |
| 유지보수 | 긴 URL 변경을 한곳에서 처리 가능 |
주의할 점
참조형 링크 식별자가 너무 많아지면 오히려 문서 하단이 복잡해질 수 있습니다. 반복 링크가 많은 문서에서 특히 효과적이라고 생각하면 판단이 쉬워집니다.
참고 링크
2 sources