숏컷 코드
[설치로 이동](#설치)
[상위 README](../README.md)
[설정 파일](./config/app.yml)문법
섹션 링크의 anchor 값은 렌더러가 제목 텍스트에서 자동 생성하며 규칙이 다를 수 있다
[텍스트](#anchor) 형태의 섹션 링크는 같은 문서 안의 제목으로 이동한다. anchor 값은 렌더러가 제목 텍스트를 변환해 자동으로 생성하는데, 대부분의 규칙은 "소문자 변환, 공백을 -로 치환, 특수 문자 제거"다. 그러나 한글, 숫자로 시작하는 제목, 같은 이름의 중복 제목 처리는 렌더러마다 차이가 있다. GitHub는 중복 제목에 -1, -2 같은 순번을 붙이고, 다른 렌더러는 다른 방식을 쓸 수 있다. 따라서 섹션 링크를 만든 뒤 반드시 실제 렌더링에서 동작을 확인해야 한다.
## 설치 방법
[설치 방법으로 이동](#설치-방법)
<!-- GitHub에서는 공백이 - 로 변환됨 -->
## 설치 방법
[두 번째 설치 방법 섹션](#설치-방법-1)
<!-- GitHub에서 중복 제목은 -1, -2 순번이 붙음 -->상대 경로 링크는 절대 URL보다 이식성이 높지만 구조 변경에 취약하다
./, ../ 로 시작하는 상대 경로 링크는 저장소 내부 파일을 연결할 때 절대 URL보다 유리하다. 도메인이나 배포 URL이 바뀌어도 저장소 구조가 동일하다면 링크가 유지된다. 반면 디렉터리 구조가 바뀌거나 파일이 이동하면 링크가 깨진다. 따라서 상대 경로 링크가 많은 문서에서는 파일 이동 시 링크 점검이 필수 작업이 된다.
## 설치
설치 전 [요구 사항](#요구-사항)을 먼저 확인합니다.
자세한 프로젝트 구조는 [가이드](../docs/guide.md)에서 이어서 봅니다.
이미지 리소스는 [스크린샷](./images/screenshot.png)을 참고합니다.제목 텍스트를 변경하면 연결된 모든 섹션 링크가 함께 깨진다
제목 anchor는 제목 텍스트에서 파생되므로, 제목 텍스트를 바꾸면 anchor도 달라진다. "설치 방법" → "설치 절차"로 바꾸면 #설치-방법을 가리키는 링크는 전부 무효가 된다. 이 문제는 단독 문서보다 문서 간 교차 링크가 많은 저장소에서 더 심각하다. 일부 정적 사이트 빌더는 명시적 ID({#custom-id}) 지정을 지원해 제목 텍스트와 anchor를 분리할 수 있다.
## 설치 절차 {#installation}
<!-- anchor를 고정해 제목 텍스트와 무관하게 유지 -->
[설치로 이동](#installation)
<!-- 제목 텍스트가 바뀌어도 anchor가 보존됨 -->이미지와 비-Markdown 파일도 상대 경로로 연결할 수 있다
상대 경로 링크는 .md 파일뿐 아니라 이미지(.png, .svg), 설정 파일(.yml, .json), 스크립트 파일 등 저장소 안의 모든 파일에 사용 가능하다. GitHub에서는 이 링크를 클릭하면 해당 파일의 GitHub 렌더링 뷰나 raw 보기로 이동한다. 이미지 파일을 ![] 대신 []() 링크로 연결하면 클릭 시 이미지 페이지로 이동하는 링크를 만들 수 있다.
스크린샷은 [여기](./docs/images/ui.png)에서 확인합니다.
전체 설정 예제는 [app.example.yml](./config/app.example.yml)을 참고합니다.선택 기준
| 상황 | 적합한 선택 |
|---|---|
| 같은 문서 안 섹션 이동 | [텍스트](#anchor) (렌더링에서 확인 필수) |
| 저장소 내 다른 파일 연결 | [텍스트](./path/to/file.md) |
| 상위 디렉터리 파일 연결 | [텍스트](../path/to/file.md) |
| 제목 anchor 고정 (렌더러 지원 시) | ## 제목 {#custom-id} |
| 문서 리팩터링 후 링크 점검 | 섹션 링크와 상대 경로 링크 모두 확인 |
주의할 점
제목 텍스트를 바꾸면 해당 제목의 anchor도 달라져 섹션 링크가 모두 깨집니다. 문서 리팩터링 뒤에는 섹션 링크를 반드시 확인하세요. 섹션 anchor 생성 규칙은 렌더러마다 다를 수 있으므로 실제 환경에서 동작을 검증하는 것이 중요합니다.
참고 링크
1 sources